ImapClientGetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken) Method

Asynchronously gets the specified metadata.

Definition

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override 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

IMailStoreGetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken)
IMailStoreGetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken)

Remarks

Gets the specified metadata.

Exceptions

ArgumentNullException

options is .

-or-

tags is .
ObjectDisposedException The ImapClient has been disposed.
ServiceNotConnectedException The ImapClient is not connected.
ServiceNotAuthenticatedException The ImapClient is not authenticated.
NotSupportedException The IMAP server does not support the METADATA or METADATA-SERVER extension.
OperationCanceledException The operation was canceled via the cancellation token.
IOException An I/O error occurred.
ImapProtocolException The server's response contained unexpected tokens.
ImapCommandException The server replied with a NO or BAD response.

See Also