ImapFolderGetStream(Int32, Int64, Int64, CancellationToken, ITransferProgress) Method

Get a substream of the specified message.

Definition

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override Stream GetStream(
	int index,
	long offset,
	long count,
	CancellationToken cancellationToken = default,
	ITransferProgress? progress = null
)

Parameters

index  Int32
The index of the message.
offset  Int64
The starting offset of the first desired byte.
count  Int64
The number of bytes desired.
cancellationToken  CancellationToken  (Optional)
The cancellation token.
progress  ITransferProgress  (Optional)
The progress reporting mechanism.

Return Value

Stream
The stream.

Implements

IMailFolderGetStream(Int32, Int64, Int64, CancellationToken, ITransferProgress)
IMailFolderGetStream(Int32, Int64, Int64, CancellationToken, ITransferProgress)

Remarks

Fetches a substream of the message. If the starting offset is beyond the end of the message, an empty stream is returned. If the number of bytes desired extends beyond the end of the message, a truncated stream will be returned.

Exceptions

ArgumentOutOfRangeException

index is out of range.

-or-

offset is negative.

-or-

count is negative.

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.

See Also