ImapDownloadEnvelopesAsync Method (String, Boolean, EnvelopeParts, Int32, String, String) |
Namespace: MailBee.ImapMailAssembly: MailBee.NET (in MailBee.NET.dll) Version: 12.5.0 build 687 for .NET 4.5
Syntax public Task<EnvelopeCollection> DownloadEnvelopesAsync(
string messageIndexSet,
bool indexIsUid,
EnvelopeParts parts,
int bodyPreviewSize,
string[] extraHeaders,
string[] extraItems
)
Public Function DownloadEnvelopesAsync (
messageIndexSet As String,
indexIsUid As Boolean,
parts As EnvelopeParts,
bodyPreviewSize As Integer,
extraHeaders As String(),
extraItems As String()
) As Task(Of EnvelopeCollection)
Parameters
- messageIndexSet
- Type: SystemString
A message sequence string containing ordinal message numbers or UIDs. Can be composed manually or using ToString. - indexIsUid
- Type: SystemBoolean
If true, messageIndexSet is treated as a sequence of UIDs; otherwise, as a sequence of ordinal message numbers. - parts
- Type: MailBee.ImapMailEnvelopeParts
Specifies which message elements or attributes to download. - bodyPreviewSize
- Type: SystemInt32
If parts includes MessagePreview flag, specifies
the length of the message body section (in bytes) to be downloaded in addition to the message header section; if 0, only the message header
is downloaded; if -1 or -2, the entire message is downloaded. -1 is the only option which also sets Seen flag marking the message as read. - extraHeaders
- Type: SystemString
The array of names of message headers to be downloaded, or a null reference (Nothing in Visual Basic)
if additional headers are not needed. - extraItems
- Type: SystemString
The array of additional FETCH request items to download, or a null reference (Nothing in Visual Basic)
if additional FETCH items are not needed.
Return Value
Type:
TaskEnvelopeCollectionA task that represents the asynchronous operation.
The value of
TResult parameter is
EnvelopeCollection object if message envelopes were downloaded successfully; otherwise, a null reference (
Nothing in Visual Basic).
Exceptions See Also