Click or drag to resize
MimeKit

ImapFolderFetchAsync(IListInt32, IFetchRequest, CancellationToken) Method

Asynchronously fetches the message summaries for the specified message indexes.

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax
C#
Copy
public override Task<IList<IMessageSummary>> FetchAsync(
	IList<int> indexes,
	IFetchRequest request,
	CancellationToken cancellationToken = default
)

Parameters

indexes  IListInt32
The indexes.
request  IFetchRequest
The fetch request.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskIListIMessageSummary
An enumeration of summaries for the requested messages.

Implements

IMailFolderFetchAsync(IListInt32, IFetchRequest, CancellationToken)
IMailFolderFetchAsync(IListInt32, IFetchRequest, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullException

indexes is null.

-or-

request is null.

ArgumentException One or more of the indexes is invalid.
ObjectDisposedException The ImapClient has been disposed.
FolderNotOpenException The ImapFolder is not currently open.
ServiceNotConnectedException The ImapClient is not connected.
ServiceNotAuthenticatedException The ImapClient is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
NotSupportedException The ImapFolder does not support mod-sequences.
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

Fetches the message summaries for the specified message indexes.

It should be noted that if another client has modified any message in the folder, the IMAP server 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