IMailFolderStore(IListUniqueId, IStoreLabelsRequest, CancellationToken) Method

Store GMail-style labels for a set of messages.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
IList<UniqueId> Store(
	IList<UniqueId> uids,
	IStoreLabelsRequest request,
	CancellationToken cancellationToken = default
)

Parameters

uids  IListUniqueId
The message UIDs.
request  IStoreLabelsRequest
The labels to store.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

IListUniqueId
The UIDs of the messages that were not updated.

Remarks

Updates the GMail-style labels for a set of messages.

Exceptions

ArgumentNullException

uids is .

-or-

request is .
ArgumentException One or more of the uids is invalid.
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