IMailFolderExtensionsSetLabelsAsync(IMailFolder, Int32, IListString, Boolean, CancellationToken) Method

Asynchronously set the labels of the specified message.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public static Task SetLabelsAsync(
	this IMailFolder folder,
	int index,
	IList<string> labels,
	bool silent,
	CancellationToken cancellationToken = default
)

Parameters

folder  IMailFolder
The folder.
index  Int32
The index of the message.
labels  IListString
The labels to set.
silent  Boolean
If set to , no MessageLabelsChanged events will be emitted.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

Task
An asynchronous task context.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IMailFolder. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Asynchronously sets the labels of the specified message.

Exceptions

ArgumentNullException labels is .
ArgumentException index 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.
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