MailFolderStoreAsync(Int32, IStoreFlagsRequest, CancellationToken) Method

Asynchronously store message flags and keywords for a message.

Definition

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

Parameters

index  Int32
The index of the message.
request  IStoreFlagsRequest
The message flags and keywords to store.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskBoolean
if the store operation was successful; otherwise, .

Implements

IMailFolderStoreAsync(Int32, IStoreFlagsRequest, CancellationToken)

Remarks

Asynchronously updates the message flags and keywords 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 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