MailSpoolGetMessageHeadersAsync(Int32, CancellationToken) Method

Asynchronously get the headers for the specified message.

Definition

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public abstract Task<HeaderList> GetMessageHeadersAsync(
	int index,
	CancellationToken cancellationToken = default
)

Parameters

index  Int32
The index of the message.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskHeaderList
The message headers.

Implements

IMailSpoolGetMessageHeadersAsync(Int32, CancellationToken)

Remarks

Asynchronously gets the headers for the specified message.

Exceptions

ArgumentOutOfRangeException index is not a valid message index.
ObjectDisposedException The MailSpool has been disposed.
ServiceNotConnectedException The MailSpool is not connected.
ServiceNotAuthenticatedException The MailSpool is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
IOException An I/O error occurred.
CommandException The command failed.
ProtocolException A protocol error occurred.

See Also