Imap FolderGet Message Async(Unique Id, Cancellation Token, ITransfer Progress) Method
Asynchronously get the specified message.
Definition
Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The message.
IMailFolderGetMessageAsync(UniqueId, CancellationToken, ITransferProgress)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override Task<MimeMessage> GetMessageAsync(
UniqueId uid,
CancellationToken cancellationToken = default,
ITransferProgress? progress = null
)Parameters
- uid UniqueId
- The UID of the message.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
- progress ITransferProgress (Optional)
- The progress reporting mechanism.
Return Value
TaskMimeMessageThe message.
Implements
IMailFolderGetMessageAsync(UniqueId, CancellationToken, ITransferProgress)IMailFolderGetMessageAsync(UniqueId, CancellationToken, ITransferProgress)
Remarks
Gets the specified message.
Exceptions
| 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 message. |
| 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. |