IMail Folder ExtensionsFetch Async(IMail Folder, IListUnique Id, UInt 64, Message Summary Items, Cancellation Token) Method
Definition
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
public static Task<IList<IMessageSummary>> FetchAsync(
this IMailFolder folder,
IList<UniqueId> uids,
ulong modseq,
MessageSummaryItems items,
CancellationToken cancellationToken = default
)Parameters
- folder IMailFolder
- The folder.
- uids IListUniqueId
- The UIDs.
- modseq UInt64
- The mod-sequence value.
- items MessageSummaryItems
- The message summary items to fetch.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
Return Value
TaskIListIMessageSummaryAn 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).Remarks
Asynchronously fetches the message summaries for the specified message UIDs that have a higher mod-sequence value than the one specified.
If the mail store supports quick resynchronization and the application has enabled this feature via EnableAsync(ImapFeatures, CancellationToken), then this method will emit MessagesVanished events for messages that have vanished since the specified mod-sequence value.
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.
Exceptions
| ArgumentNullException | uids is . |
| 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. |