| IMailFolderGetStreamAsync(Int32, Int32, Int32, CancellationToken, ITransferProgress) Method |
Asynchronously get a substream of the specified message.
Namespace: MailKitAssembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax Task<Stream> GetStreamAsync(
int index,
int offset,
int count,
CancellationToken cancellationToken = default,
ITransferProgress progress = null
)
Parameters
- index Int32
- The index 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
TaskStreamThe stream.
Remarks
Asynchronously gets 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.
See Also