Click or drag to resize
MimeKit

IMailFolderExtensionsFetch Method (IMailFolder, IListInt32, MessageSummaryItems, CancellationToken)

Fetch the message summaries for the specified message indexes.

Namespace:  MailKit
Assembly:  MailKit (in MailKit.dll) Version: 3.0.0
Syntax
C#
public static IList<IMessageSummary> Fetch(
	this IMailFolder folder,
	IList<int> indexes,
	MessageSummaryItems items,
	CancellationToken cancellationToken = default
)

Parameters

folder
Type: MailKitIMailFolder
The folder.
indexes
Type: System.Collections.GenericIListInt32
The indexes.
items
Type: MailKitMessageSummaryItems
The message summary items to fetch.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: IListIMessageSummary
An enumeration of summaries for the requested messages.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IMailFolder. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Exceptions
ExceptionCondition
ArgumentNullExceptionindexes is null.
ArgumentException One or more of the indexes 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

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 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