IMailFolderGetMetadataAsync(MetadataTag, CancellationToken) Method

Asynchronously gets the specified metadata.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
Task<string?> GetMetadataAsync(
	MetadataTag tag,
	CancellationToken cancellationToken = default
)

Parameters

tag  MetadataTag
The metadata tag.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskString
The requested metadata value.

Remarks

Asynchronously gets the specified metadata.

Exceptions

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.

See Also