IMailFolderGetHeadersAsync(Int32, CancellationToken, ITransferProgress) Method

Asynchronously get the specified message headers.

Definition

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

Parameters

index  Int32
The index of the message.
cancellationToken  CancellationToken  (Optional)
The cancellation token.
progress  ITransferProgress  (Optional)
The progress reporting mechanism.

Return Value

TaskHeaderList
The message headers.

Remarks

Asynchronously gets the specified message headers.

Exceptions

ArgumentOutOfRangeException index is out of range.
ObjectDisposedException The IMailStore has been disposed.
ServiceNotConnectedException The IMailStore is not connected.
ServiceNotAuthenticatedException The IMailStore is not authenticated.
FolderNotOpenException The folder is not currently open.
MessageNotFoundException The IMailStore did not return the requested message headers.
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