Click or drag to resize
MimeKit

ImapFolderStore(IListUniqueId, IStoreLabelsRequest, CancellationToken) Method

Store GMail-style labels for a set of messages.

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
public override IList<UniqueId> Store(
	IList<UniqueId> uids,
	IStoreLabelsRequest request,
	CancellationToken cancellationToken = default
)

Parameters

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

Return Value

IListUniqueId
The UIDs of the messages that were not updated.

Implements

IMailFolderStore(IListUniqueId, IStoreLabelsRequest, CancellationToken)
IMailFolderStore(IListUniqueId, IStoreLabelsRequest, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullException

uids is null.

-or-

request is null.

ArgumentException One or more of the uids is invalid.
ObjectDisposedException The ImapClient has been disposed.
ServiceNotConnectedException The ImapClient is not connected.
ServiceNotAuthenticatedException The ImapClient is not authenticated.
FolderNotOpenException The ImapFolder is not currently open in read-write mode.
NotSupportedException The request specified an UnchangedSince value but the ImapFolder does not support mod-sequences.
OperationCanceledException The operation was canceled via the cancellation token.
IOException An I/O error occurred.
ImapProtocolException The server's response contained unexpected tokens.
ImapCommandException The server replied with a NO or BAD response.
Remarks
Updates the GMail-style labels for a set of messages.
See Also