Click or drag to resize
MimeKit

ImapClientGetMetadataAsync Method (MetadataTag, CancellationToken)

Asynchronously gets the specified metadata.

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

Parameters

tag
Type: MailKitMetadataTag
The metadata tag.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: TaskString
The requested metadata value.

Implements

IMailStoreGetMetadataAsync(MetadataTag, CancellationToken)
IMailStoreGetMetadataAsync(MetadataTag, CancellationToken)
Exceptions
ExceptionCondition
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