Imap FolderGet Headers(Unique Id, Body Part, Cancellation Token, ITransfer Progress) Method
Get the specified body part headers.
Definition
Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The body part headers.
IMailFolderGetHeaders(UniqueId, BodyPart, CancellationToken, ITransferProgress)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override HeaderList GetHeaders(
UniqueId uid,
BodyPart part,
CancellationToken cancellationToken = default,
ITransferProgress? progress = null
)Parameters
- uid UniqueId
- The UID of the message.
- part BodyPart
- The body part.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
- progress ITransferProgress (Optional)
- The progress reporting mechanism.
Return Value
HeaderListThe body part headers.
Implements
IMailFolderGetHeaders(UniqueId, BodyPart, CancellationToken, ITransferProgress)IMailFolderGetHeaders(UniqueId, BodyPart, CancellationToken, ITransferProgress)
Remarks
Gets the specified body part headers.
Exceptions
| ArgumentNullException | part is . |
| ArgumentException | uid is invalid. |
| 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 body part 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. |