Click or drag to resize
MimeKit

MailStoreGetMetadataAsync Method (MetadataOptions, IEnumerableMetadataTag, CancellationToken)

Asynchronously gets the specified metadata.

Namespace:  MailKit
Assembly:  MailKit (in MailKit.dll) Version: 2.14.0
Syntax
C#
public abstract Task<MetadataCollection> GetMetadataAsync(
	MetadataOptions options,
	IEnumerable<MetadataTag> tags,
	CancellationToken cancellationToken = default
)

Parameters

options
Type: MailKitMetadataOptions
The metadata options.
tags
Type: System.Collections.GenericIEnumerableMetadataTag
The metadata tags.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: TaskMetadataCollection
The requested metadata.

Implements

IMailStoreGetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullException

options is null.

-or-

tags is null.

ObjectDisposedException The MailStore has been disposed.
ServiceNotConnectedException The MailStore is not connected.
ServiceNotAuthenticatedException The MailStore is not authenticated.
NotSupportedException The folder does not support metadata.
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.
Remarks
Asynchronously gets the specified metadata.
See Also