Click or drag to resize
MimeKit

ImapFolderGetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken) Method

Asynchronously get the specified metadata.

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
Copy
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

IMailFolderGetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken)
IMailFolderGetMetadataAsync(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 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