Click or drag to resize
MimeKit

ImapFolderCopyToAsync(IListUniqueId, IMailFolder, CancellationToken) Method

Asynchronously copy the specified messages to the destination folder.

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
public override 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)
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 ImapClient.

ObjectDisposedException The ImapClient has been disposed.
ServiceNotConnectedException The ImapClient is not connected.
ServiceNotAuthenticatedException The ImapClient is not authenticated.
FolderNotFoundExceptiondestination does not exist.
FolderNotOpenException The ImapFolder is not currently open.
NotSupportedException The IMAP server does not support the UIDPLUS extension.
OperationCanceledException The operation was canceled via the cancellation token.
IOException An I/O error occurred.
ImapProtocolException The server's response contained unexpected tokens.
ImapCommandException The server replied with a NO or BAD response.
Remarks
Copies the specified messages to the destination folder.
See Also