Pop 3ClientGet Message Headers Async(IListInt 32, Cancellation Token) Method
Asynchronously get the headers for the messages at the specified indexes.
Definition
Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The headers for the specified messages.
IMailSpoolGetMessageHeadersAsync(IListInt32, CancellationToken)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
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
TaskIListHeaderListThe headers for the specified messages.
Implements
IMailSpoolGetMessageHeadersAsync(IListInt32, CancellationToken)IMailSpoolGetMessageHeadersAsync(IListInt32, CancellationToken)
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.
Exceptions
| ArgumentNullException | indexes is . |
| 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. |