MailFolderAppendAsync(FormatOptions, IAppendRequest, CancellationToken) Method

Asynchronously append a message to the folder.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public abstract Task<UniqueId?> AppendAsync(
	FormatOptions options,
	IAppendRequest request,
	CancellationToken cancellationToken = default
)

Parameters

options  FormatOptions
The formatting options.
request  IAppendRequest
The append request.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskNullableUniqueId
The UID of the appended message, if available; otherwise, .

Implements

IMailFolderAppendAsync(FormatOptions, IAppendRequest, CancellationToken)

Remarks

Asynchronously appends a message to the folder and returns the UniqueId assigned to the message.

Exceptions

ArgumentNullException

options is .

-or-

request is .

ObjectDisposedException The IMailStore has been disposed.
ServiceNotConnectedException The IMailStore is not connected.
ServiceNotAuthenticatedException The IMailStore is not authenticated.
InvalidOperationException Internationalized formatting was requested but has not been enabled.
FolderNotFoundException The MailFolder 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-

The request included annotations but the folder does not support annotations.

IOException An I/O error occurred.
ProtocolException The server's response contained unexpected tokens.
CommandException The command failed.

See Also