Click or drag to resize
MimeKit

ImapFolderGetMessageAsync(UniqueId, CancellationToken, ITransferProgress) Method

Asynchronously get the specified message.

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax
C#
Copy
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

TaskMimeMessage
The message.

Implements

IMailFolderGetMessageAsync(UniqueId, CancellationToken, ITransferProgress)
IMailFolderGetMessageAsync(UniqueId, CancellationToken, ITransferProgress)
Exceptions
ExceptionCondition
ArgumentExceptionuid 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.
Remarks
Gets the specified message.
See Also