IImapFolderGetHeadersAsync(Int32, String, CancellationToken, ITransferProgress) Method

Asynchronously get the specified body part headers.

Definition

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
Task<HeaderList> GetHeadersAsync(
	int index,
	string partSpecifier,
	CancellationToken cancellationToken = default,
	ITransferProgress? progress = null
)

Parameters

index  Int32
The index 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.

Remarks

Gets the specified body part headers.

Exceptions

ArgumentOutOfRangeException index is out of range.
ArgumentNullException partSpecifier is .
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.

See Also