Click or drag to resize
MimeKit

MailFolderFetchAsync(IListUniqueId, IFetchRequest, CancellationToken) Method

Asynchronously fetch the message summaries for the specified message UIDs.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
Copy
public abstract Task<IList<IMessageSummary>> FetchAsync(
	IList<UniqueId> uids,
	IFetchRequest request,
	CancellationToken cancellationToken = default
)

Parameters

uids  IListUniqueId
The UIDs.
request  IFetchRequest
The fetch request.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskIListIMessageSummary
An enumeration of summaries for the requested messages.

Implements

IMailFolderFetchAsync(IListUniqueId, IFetchRequest, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullException

uids is null.

-or-

request is null.

ArgumentException One or more of the uids is invalid.
ObjectDisposedException The IMailStore has been disposed.
ServiceNotConnectedException The IMailStore is not connected.
ServiceNotAuthenticatedException The IMailStore is not authenticated.
FolderNotOpenException The folder is not currently open.
OperationCanceledException The operation was canceled via the cancellation token.
IOException An I/O error occurred.
ProtocolException The server's response contained unexpected tokens.
CommandException The command failed.
Remarks

Asynchronously fetches the message summaries for the specified message UIDs.

It should be noted that if another client has modified any message in the folder, the mail service may choose to return information that was not explicitly requested. It is therefore important to be prepared to handle both additional fields on a IMessageSummary for messages that were requested as well as summaries for messages that were not requested at all.

See Also