Pop 3ClientGet Message Headers Async(Int 32, Int 32, Cancellation Token) Method
Asynchronously get the headers of the messages within the specified range.
Definition
Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The headers of the messages within the specified range.
IMailSpoolGetMessageHeadersAsync(Int32, Int32, CancellationToken)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override Task<IList<HeaderList>> GetMessageHeadersAsync(
int startIndex,
int count,
CancellationToken cancellationToken = default
)Parameters
- startIndex Int32
- The index of the first message to get.
- count Int32
- The number of messages to get.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
Return Value
TaskIListHeaderListThe headers of the messages within the specified range.
Implements
IMailSpoolGetMessageHeadersAsync(Int32, Int32, CancellationToken)IMailSpoolGetMessageHeadersAsync(Int32, Int32, CancellationToken)
Remarks
Gets the headers of the messages within the specified range.
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.
Exceptions
| ArgumentOutOfRangeException | startIndex and count do not specify a valid range of messages. |
| 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. |