Click or drag to resize
MimeKit

MailFolderStore(Int32, IStoreLabelsRequest, CancellationToken) Method

Store GMail-style labels for a message.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax
C#
public virtual bool Store(
	int index,
	IStoreLabelsRequest request,
	CancellationToken cancellationToken = default
)

Parameters

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

Return Value

Boolean
true if the store operation was successful; otherwise, false.

Implements

IMailFolderStore(Int32, IStoreLabelsRequest, CancellationToken)
Exceptions
ExceptionCondition
ArgumentExceptionindex is invalid.
ArgumentNullExceptionrequest is null.
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.
Remarks
Updates the GMail-style labels for a message.
See Also