IMailFolderExtensionsAddFlagsAsync(IMailFolder, IListInt32, UInt64, MessageFlags, HashSetString, Boolean, CancellationToken) Method

Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

Definition

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

Parameters

folder  IMailFolder
The folder.
indexes  IListInt32
The indexes of the messages.
modseq  UInt64
The mod-sequence value.
flags  MessageFlags
The message flags to add.
keywords  HashSetString
A set of user-defined flags to add.
silent  Boolean
If set to , no MessageFlagsChanged events will be emitted.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskIListInt32
The indexes of the messages that were not updated.

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 adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.

Exceptions

ArgumentNullException indexes is .
ArgumentException One or more of the indexes 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 MailFolder 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