Click or drag to resize
MimeKit

ImapFolderGetStreamAsync(Int32, String, CancellationToken, ITransferProgress) Method

Asynchronously gets a substream of the specified message.

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 4.12.1
Syntax
C#
Copy
public override 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)
IMailFolderGetStreamAsync(Int32, String, CancellationToken, ITransferProgress)
Exceptions
ExceptionCondition
ArgumentNullExceptionsection is .
ArgumentOutOfRangeExceptionindex is out of range.
ObjectDisposedException The ImapClient has been disposed.
ServiceNotConnectedException The ImapClient is not connected.
ServiceNotAuthenticatedException The ImapClient is not authenticated.
FolderNotOpenException The ImapFolder is not currently open.
MessageNotFoundException The IMAP server did not return the requested message stream.
OperationCanceledException The operation was canceled via the cancellation token.
IOException An I/O error occurred.
ImapProtocolException The server's response contained unexpected tokens.
ImapCommandException The server replied with a NO or BAD response.
Remarks

Gets a substream of the specified message.

Note  Note
For more information about how to construct the section, see RFC3501, Section 6.4.5.
See Also