Click or drag to resize
MimeKit

ImapFolderGetHeadersAsync(UniqueId, String, CancellationToken, ITransferProgress) Method

Asynchronously get the specified body part headers.

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax
C#
Copy
public virtual Task<HeaderList> GetHeadersAsync(
	UniqueId uid,
	string partSpecifier,
	CancellationToken cancellationToken = default,
	ITransferProgress progress = null
)

Parameters

uid  UniqueId
The UID of the message.
partSpecifier  String
The body part specifier.
cancellationToken  CancellationToken  (Optional)
The cancellation token.
progress  ITransferProgress  (Optional)
The progress reporting mechanism.

Return Value

TaskHeaderList
The body part headers.

Implements

IImapFolderGetHeadersAsync(UniqueId, String, CancellationToken, ITransferProgress)
Exceptions
ExceptionCondition
ArgumentNullExceptionpartSpecifier is null.
ArgumentExceptionuid is invalid.
ObjectDisposedException The ImapClient has been disposed.
ServiceNotConnectedException The ImapClient is not connected.
ServiceNotAuthenticatedException The ImapClient is not authenticated.
FolderNotOpenException The ImapFolder is not currently open.
MessageNotFoundException The IMAP server did not return the requested body part headers.
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 body part headers.
See Also