MailKit Documentation
API Reference
MailKit
IMailFolderExtensions Class
IMailFolderExtensions Methods
FetchAsync Method
FetchAsync(IMailFolder, IList<UniqueId>, MessageSummaryItems, CancellationToken) Method
FetchAsync(IMailFolder, IList<Int32>, MessageSummaryItems, CancellationToken) Method
FetchAsync(IMailFolder, IList<UniqueId>, MessageSummaryItems, IEnumerable<HeaderId>, CancellationToken) Method
FetchAsync(IMailFolder, IList<UniqueId>, MessageSummaryItems, IEnumerable<String>, CancellationToken) Method
FetchAsync(IMailFolder, IList<UniqueId>, UInt64, MessageSummaryItems, CancellationToken) Method
FetchAsync(IMailFolder, IList<Int32>, MessageSummaryItems, IEnumerable<HeaderId>, CancellationToken) Method
FetchAsync(IMailFolder, IList<Int32>, MessageSummaryItems, IEnumerable<String>, CancellationToken) Method
FetchAsync(IMailFolder, IList<Int32>, UInt64, MessageSummaryItems, CancellationToken) Method
FetchAsync(IMailFolder, Int32, Int32, MessageSummaryItems, CancellationToken) Method
FetchAsync(IMailFolder, IList<UniqueId>, UInt64, MessageSummaryItems, IEnumerable<HeaderId>, CancellationToken) Method
FetchAsync(IMailFolder, IList<UniqueId>, UInt64, MessageSummaryItems, IEnumerable<String>, CancellationToken) Method
FetchAsync(IMailFolder, IList<Int32>, UInt64, MessageSummaryItems, IEnumerable<HeaderId>, CancellationToken) Method
FetchAsync(IMailFolder, IList<Int32>, UInt64, MessageSummaryItems, IEnumerable<String>, CancellationToken) Method
FetchAsync(IMailFolder, Int32, Int32, MessageSummaryItems, IEnumerable<HeaderId>, CancellationToken) Method
FetchAsync(IMailFolder, Int32, Int32, MessageSummaryItems, IEnumerable<String>, CancellationToken) Method
FetchAsync(IMailFolder, Int32, Int32, UInt64, MessageSummaryItems, CancellationToken) Method
FetchAsync(IMailFolder, Int32, Int32, UInt64, MessageSummaryItems, IEnumerable<HeaderId>, CancellationToken) Method
FetchAsync(IMailFolder, Int32, Int32, UInt64, MessageSummaryItems, IEnumerable<String>, CancellationToken) Method
Click or drag to resize
MimeKit

IMailFolderExtensionsFetchAsync(IMailFolder, IListUniqueId, MessageSummaryItems, IEnumerableHeaderId, CancellationToken) Method

Asynchronously fetch the message summaries for the specified message UIDs.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax
C#
Copy
public static Task<IList<IMessageSummary>> FetchAsync(
	this IMailFolder folder,
	IList<UniqueId> uids,
	MessageSummaryItems items,
	IEnumerable<HeaderId> headers,
	CancellationToken cancellationToken = default
)

Parameters

folder  IMailFolder
The folder.
uids  IListUniqueId
The UIDs.
items  MessageSummaryItems
The message summary items to fetch.
headers  IEnumerableHeaderId
The desired header fields.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

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

uids is null.

-or-

headers is null.

ArgumentException

One or more of the uids is invalid.

-or-

One or more of the specified headers 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