Click or drag to resize
MimeKit

MailFolderGetStreamAsync(Int32, BodyPart, CancellationToken, ITransferProgress) Method

Asynchronously get a body part as a stream.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax
C#
Copy
public virtual Task<Stream> GetStreamAsync(
	int index,
	BodyPart part,
	CancellationToken cancellationToken = default,
	ITransferProgress progress = null
)

Parameters

index  Int32
The index of the message.
part  BodyPart
The desired body part.
cancellationToken  CancellationToken  (Optional)
The cancellation token.
progress  ITransferProgress  (Optional)
The progress reporting mechanism.

Return Value

TaskStream
The body part stream.

Implements

IMailFolderGetStreamAsync(Int32, BodyPart, CancellationToken, ITransferProgress)
Exceptions
ExceptionCondition
ArgumentNullExceptionpart is null.
ArgumentOutOfRangeException

index is out of range.

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.
Remarks
Asynchronously gets a body part as a stream.
See Also