IMAPIFolder::CopyMessages

4/8/2010

The CopyMessages method copies or moves one or more messages to another folder.

Syntax

HRESULT CopyMessages (
  LPENTRYLIST lpMsgList,
  LPCIID lpInterface,
  LPVOID lpDestFolder,
  ULONG ulUIParam,
  LPMAPIPROGRESS lpProgress,
  ULONG ulFlags
);

Parameters

• lpMsgList
  [in] Reference to an ENTRYLIST structure that contains an array of messages to copy or move; cannot be NULL.

• lpInterface
  [in] Must be NULL.

• lpDestFolder
  [in] Reference to the open folder to receive the copied or moved messages.

• ulUIParam
  [in] Must be zero.

• lpProgress
  [in] Ignored.

• ulFlags
  [in] Bitmask of flags that controls how the copy or move operation is accomplished. The following flags can be set:

  MESSAGE_MOVE

  The message or messages are to be moved rather than copied. If MESSAGE_MOVE is not set, the messages are copied.

Return Value

This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

• S_OK
  Indicates success.

• MAPI_E_DECLINE_COPY
  The provider implements this method by calling a support object method, and the caller has passed the MAPI_DECLINE_OK flag.

• MAPI_W_PARTIAL_COMPLETION
  The call succeeded, but not all entries were successfully copied or moved. When this warning is returned, the call should be handled as successful.

Remarks

Messages that are open with read/write access can be moved or copied.

When CopyMessages is unable to complete, do not assume that no work was done. CopyMessages might have been able to copy or move one or more messages before encountering the error.

Requirements

See Also

Reference

IMAPIFolder

Other Resources

Messaging