IMailFolderExtensionsSetFlagsAsync(IMailFolder, IListUniqueId, MessageFlags, HashSetString, Boolean, CancellationToken) Method

Asynchronously set the flags of the specified messages.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public static Task SetFlagsAsync(
	this IMailFolder folder,
	IList<UniqueId> uids,
	MessageFlags flags,
	HashSet<string> keywords,
	bool silent,
	CancellationToken cancellationToken = default
)

Parameters

folder  IMailFolder
The folder.
uids  IListUniqueId
The UIDs of the messages.
flags  MessageFlags
The message flags to set.
keywords  HashSetString
A set of user-defined flags to set.
silent  Boolean
If set to , no MessageFlagsChanged 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 flags of the specified messages.

Exceptions

ArgumentNullException uids 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.
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