Imap FolderAppend(Format Options, IListIAppend Request, Cancellation Token) Method
Append multiple messages to the folder.
Definition
Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The UIDs of the appended messages, if available; otherwise an empty array.
IMailFolderAppend(FormatOptions, IListIAppendRequest, CancellationToken)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override IList<UniqueId> Append(
FormatOptions options,
IList<IAppendRequest> requests,
CancellationToken cancellationToken = default
)Parameters
- options FormatOptions
- The formatting options.
- requests IListIAppendRequest
- The append requests.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
Return Value
IListUniqueIdThe UIDs of the appended messages, if available; otherwise an empty array.
Implements
IMailFolderAppend(FormatOptions, IListIAppendRequest, CancellationToken)IMailFolderAppend(FormatOptions, IListIAppendRequest, CancellationToken)
Remarks
Appends multiple messages to the folder and returns the UniqueIds assigned to the messages.
Only the TransferProgress of the first request is used, and it reports the progress of the entire batch.
Exceptions
| ArgumentNullException |
options is . -or- requests is . |
| ArgumentException | One or more of the requests is . |
| ObjectDisposedException | The ImapClient has been disposed. |
| ServiceNotConnectedException | The ImapClient is not connected. |
| ServiceNotAuthenticatedException | The ImapClient is not authenticated. |
| InvalidOperationException | Internationalized formatting was requested but has not been enabled. |
| FolderNotFoundException | The ImapFolder does not exist. |
| OperationCanceledException | The operation was canceled via the cancellation token. |
| NotSupportedException |
Internationalized formatting was requested but is not supported by the server. -or- One ore more requests included annotations but the folder does not support annotations. |
| IOException | An I/O error occurred. |
| ImapProtocolException | The server's response contained unexpected tokens. |
| ImapCommandException | The server replied with a NO or BAD response. |