Click or drag to resize
MimeKit

MailFolderCopyToAsync(IListUniqueId, IMailFolder, CancellationToken) Method

Asynchronously copy the specified messages to the destination folder.

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

Parameters

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.

Implements

IMailFolderCopyToAsync(IListUniqueId, IMailFolder, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullException

uids is null.

-or-

destination is null.

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.
Remarks
Asynchronously copies the specified messages to the destination folder.
See Also