Imap FolderGet Headers Async(Int 32, Cancellation Token, ITransfer Progress) Method
Asynchronously get the specified message headers.
Definition
Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The message headers.
IMailFolderGetHeadersAsync(Int32, CancellationToken, ITransferProgress)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override Task<HeaderList> GetHeadersAsync(
int index,
CancellationToken cancellationToken = default,
ITransferProgress? progress = null
)Parameters
- index Int32
- The index of the message.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
- progress ITransferProgress (Optional)
- The progress reporting mechanism.
Return Value
TaskHeaderListThe message headers.
Implements
IMailFolderGetHeadersAsync(Int32, CancellationToken, ITransferProgress)IMailFolderGetHeadersAsync(Int32, CancellationToken, ITransferProgress)
Remarks
Gets the specified message headers.
Exceptions
| ArgumentOutOfRangeException | index is out of range. |
| ObjectDisposedException | The ImapClient has been disposed. |
| ServiceNotConnectedException | The ImapClient is not connected. |
| ServiceNotAuthenticatedException | The ImapClient is not authenticated. |
| FolderNotOpenException | The ImapFolder is not currently open. |
| MessageNotFoundException | The IMAP server did not return the requested message headers. |
| OperationCanceledException | The operation was canceled via the cancellation token. |
| IOException | An I/O error occurred. |
| ImapProtocolException | The server's response contained unexpected tokens. |
| ImapCommandException | The server replied with a NO or BAD response. |