IMailFolderExtensionsCopyToAsync(IMailFolder, IListUniqueId, IMailFolder, CancellationToken) Method

Asynchronously copy the specified messages to the destination folder.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public static Task<UniqueIdMap> CopyToAsync(
	this IMailFolder folder,
	IList<UniqueId> uids,
	IMailFolder destination,
	CancellationToken cancellationToken = default
)

Parameters

folder  IMailFolder
The folder.
uids  IListUniqueId
The UIDs of the messages to copy.
destination  IMailFolder
The destination folder.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskUniqueIdMap
The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IMailFolder. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Asynchronously copies the specified messages to the destination folder.

Exceptions

ArgumentNullException

uids is .

-or-

destination is .
ArgumentException

One or more of the uids is invalid.

-or-

The destination folder does not belong to the IMailStore.
ObjectDisposedException The IMailStore has been disposed.
ServiceNotConnectedException The IMailStore is not connected.
ServiceNotAuthenticatedException The IMailStore is not authenticated.
FolderNotOpenException The folder is not currently open.
NotSupportedException The mail store does not support the UIDPLUS extension.
OperationCanceledException The operation was canceled via the cancellation token.
IOException An I/O error occurred.
ProtocolException The server's response contained unexpected tokens.
CommandException The command failed.

See Also