IMailFolderStoreAsync(Int32, IStoreLabelsRequest, CancellationToken) Method

Asynchronously store GMail-style labels for a message.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
Task<bool> StoreAsync(
	int index,
	IStoreLabelsRequest request,
	CancellationToken cancellationToken = default
)

Parameters

index  Int32
The index of the message.
request  IStoreLabelsRequest
The labels to store.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskBoolean
if the store operation was successful; otherwise, .

Remarks

Asynchronously updates the GMail-style labels for a message.

Exceptions

ArgumentException index is invalid.
ArgumentNullException request is .
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 in read-write mode.
NotSupportedException

The folder does not support storing labels.

-or-

The request specified an UnchangedSince value but the folder does not support mod-sequences.
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