IMail FolderGet Stream(Int 32, String, Int 64, Int 64, Cancellation Token, ITransfer Progress) Method
Get a substream of the specified message.
Definition
Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The stream.
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
Stream GetStream(
int index,
string section,
long offset,
long count,
CancellationToken cancellationToken = default,
ITransferProgress? progress = null
)Parameters
- index Int32
- The index of the message.
- section String
- The desired section 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
StreamThe stream.
Remarks
Gets a substream of the specified message. If the starting offset is beyond the end of the specified section of the message, an empty stream is returned. If the number of bytes desired extends beyond the end of the section, a truncated stream will be returned.
For more information about how to construct the section, see Section 6.4.5 of RFC3501.
Exceptions
| ArgumentNullException | section is . |
| ArgumentOutOfRangeException |
index is out of range. -or- offset is negative. -or- count is negative. |
| 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. |