Click or drag to resize
MimeKit

Pop3ClientGetMessageHeadersAsync(IListInt32, CancellationToken) Method

Asynchronously get the headers for the messages at the specified indexes.

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
Copy
public override Task<IList<HeaderList>> GetMessageHeadersAsync(
	IList<int> indexes,
	CancellationToken cancellationToken = default
)

Parameters

indexes  IListInt32
The indexes of the messages.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskIListHeaderList
The headers for the specified messages.

Implements

IMailSpoolGetMessageHeadersAsync(IListInt32, CancellationToken)
IMailSpoolGetMessageHeadersAsync(IListInt32, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullExceptionindexes is null.
ArgumentException One or more of the indexes are invalid.
ObjectDisposedException The Pop3Client has been disposed.
ServiceNotConnectedException The Pop3Client is not connected.
ServiceNotAuthenticatedException The Pop3Client is not authenticated.
NotSupportedException The POP3 server does not support the UIDL extension.
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.
Remarks

Gets the headers for the messages at the specified indexes.

When the POP3 server supports the Pipelining extension, this method will likely be more efficient than using GetMessageHeaders(Int32, CancellationToken) for each message because it will batch the commands to reduce latency.

See Also