Click or drag to resize
MimeKit

MailFolderGetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken) Method

Asynchronously gets the specified metadata.

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

Parameters

options  MetadataOptions
The metadata options.
tags  IEnumerableMetadataTag
The metadata tags.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskMetadataCollection
The requested metadata.

Implements

IMailFolderGetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullException

options is null.

-or-

tags is null.

ObjectDisposedException The IMailStore has been disposed.
ServiceNotConnectedException The IMailStore is not connected.
ServiceNotAuthenticatedException The IMailStore 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