Click or drag to resize
MimeKit

MailFolderGetStreamAsync(Int32, String, CancellationToken, ITransferProgress) Method

Asynchronously get a substream of the specified body part.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.12.1
Syntax
C#
Copy
public abstract Task<Stream> GetStreamAsync(
	int index,
	string section,
	CancellationToken cancellationToken = default,
	ITransferProgress progress = null
)

Parameters

index  Int32
The index of the message.
section  String
The desired section of the message.
cancellationToken  CancellationToken  (Optional)
The cancellation token.
progress  ITransferProgress  (Optional)
The progress reporting mechanism.

Return Value

TaskStream
The stream.

Implements

IMailFolderGetStreamAsync(Int32, String, CancellationToken, ITransferProgress)
Exceptions
ExceptionCondition
ArgumentNullExceptionsection is .
ArgumentOutOfRangeExceptionindex 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 substream of the specified message.

For more information about how to construct the section, see Section 6.4.5 of RFC3501.

See Also