Pop3ClientGetMessageHeadersAsync(Int32, CancellationToken) Method

Asynchronously get the headers for the message at the specified index.

Definition

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override 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)
IMailSpoolGetMessageHeadersAsync(Int32, CancellationToken)

Remarks

Gets the headers for the message at the specified index.

Exceptions

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

See Also