Mail FolderGet Stream Async(Unique Id, Body Part, Cancellation Token, ITransfer Progress) Method
Asynchronously get a body part as a stream.
Definition
Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The body part stream.
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public virtual Task<Stream> GetStreamAsync(
UniqueId uid,
BodyPart part,
CancellationToken cancellationToken = default,
ITransferProgress? progress = null
)Parameters
- uid UniqueId
- The UID of the message.
- part BodyPart
- The desired body part.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
- progress ITransferProgress (Optional)
- The progress reporting mechanism.
Return Value
TaskStreamThe body part stream.
Implements
IMailFolderGetStreamAsync(UniqueId, BodyPart, CancellationToken, ITransferProgress)Remarks
Asynchronously gets a body part as a stream.
Example
C#
public static void CacheBodyParts (string baseDirectory)
{
using (var client = new ImapClient ()) {
client.Connect ("imap.gmail.com", 993, SecureSocketOptions.SslOnConnect);
client.Authenticate ("username", "password");
client.Inbox.Open (FolderAccess.ReadOnly);
// search for messages where the Subject header contains either "MimeKit" or "MailKit"
var query = SearchQuery.SubjectContains ("MimeKit").Or (SearchQuery.SubjectContains ("MailKit"));
var uids = client.Inbox.Search (query);
// fetch summary information for the search results (we will want the UID and the BODYSTRUCTURE
// of each message so that we can extract the text body and the attachments)
var items = client.Inbox.Fetch (uids, MessageSummaryItems.UniqueId | MessageSummaryItems.BodyStructure);
foreach (var item in items) {
// determine a directory to save stuff in
var directory = Path.Combine (baseDirectory, item.UniqueId.ToString ());
// create the directory
Directory.CreateDirectory (directory);
// now iterate over all of the body parts and save them to disk
foreach (var bodyPart in item.BodyParts) {
// cache the raw body part MIME just like we did with the body
using (var stream = client.Inbox.GetStream (item.UniqueId, bodyPart)) {
var path = Path.Combine (directory, bodyPart.PartSpecifier);
using (var output = File.Create (path))
stream.CopyTo (output);
}
}
}
client.Disconnect (true);
}
}
Exceptions
| ArgumentException | uid is invalid. |
| ArgumentNullException | part is . |
| 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. |
| MessageNotFoundException | The IMailStore did not return the requested message stream. |
| 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. |