IMailFolderExtensionsStoreAsync(IMailFolder, IListUniqueId, UInt64, IListAnnotation, CancellationToken) Method

Asynchronously store the annotations for 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<UniqueId>> StoreAsync(
	this IMailFolder folder,
	IList<UniqueId> uids,
	ulong modseq,
	IList<Annotation> annotations,
	CancellationToken cancellationToken = default
)

Parameters

folder  IMailFolder
The folder.
uids  IListUniqueId
The UIDs of the messages.
modseq  UInt64
The mod-sequence value.
annotations  IListAnnotation
The annotations to store.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskIListUniqueId
The unique IDs 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 stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.

Exceptions

ArgumentNullException

uids is .

-or-

annotations 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 IMailFolder is not currently open in read-write mode.
InvalidOperationException Cannot store annotations without any properties defined.
NotSupportedException

The IMailFolder does not support annotations.

-or-

The IMailFolder 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