ImapFolderFetch(IListInt32, IFetchRequest, CancellationToken) Method

Fetches the message summaries for the specified message indexes.

Definition

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override IList<IMessageSummary> Fetch(
	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

IListIMessageSummary
An enumeration of summaries for the requested messages.

Implements

IMailFolderFetch(IListInt32, IFetchRequest, CancellationToken)
IMailFolderFetch(IListInt32, IFetchRequest, CancellationToken)

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.

Exceptions

ArgumentNullException

indexes is .

-or-

request is .

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.

-or-

The fetch request included a partial range, which is only supported for UID-based FETCH requests.

IOException An I/O error occurred.
ImapProtocolException The server's response contained unexpected tokens.
ImapCommandException The server replied with a NO or BAD response.

See Also