| IMailFolderGetStream(Int32, String, Int32, Int32, CancellationToken, ITransferProgress) Method |
Get a substream of the specified message.
Namespace: MailKitAssembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax Stream GetStream(
int index,
string section,
int offset,
int count,
CancellationToken cancellationToken = default,
ITransferProgress progress = null
)
Parameters
- index Int32
- The index of the message.
- section String
- The desired section of the message.
- offset Int32
- The starting offset of the first desired byte.
- count Int32
- 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.
See Also