Click or drag to resize
MimeKit

ImapClientGetMetadataAsync Method (MetadataOptions, IEnumerableMetadataTag, CancellationToken)

Asynchronously gets the specified metadata.

Namespace:  MailKit.Net.Imap
Assembly:  MailKit (in MailKit.dll) Version: 2.10.0
Syntax
C#
public override Task<MetadataCollection> GetMetadataAsync(
	MetadataOptions options,
	IEnumerable<MetadataTag> tags,
	CancellationToken cancellationToken = null
)

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)
IMailStoreGetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullException

options is null.

-or-

tags is null.

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.
Remarks
Gets the specified metadata.
See Also