| IMailFolderGetStream(UniqueId, BodyPart, Int32, Int32, CancellationToken, ITransferProgress) Method |
Get a substream of the specified body part.
Namespace: MailKitAssembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax Stream GetStream(
UniqueId uid,
BodyPart part,
int offset,
int count,
CancellationToken cancellationToken = default,
ITransferProgress progress = null
)
Parameters
- uid UniqueId
- The UID of the message.
- part BodyPart
- The desired body part.
- 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 body part. If the starting offset is beyond
the end of the body part, an empty stream is returned. If the number of
bytes desired extends beyond the end of the body part, a truncated stream
will be returned.
See Also