Imap FolderGet Stream(Unique Id, Int 64, Int 64, Cancellation Token, ITransfer Progress) Method
Get a substream of the specified message.
Definition
Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The stream.
IMailFolderGetStream(UniqueId, Int64, Int64, CancellationToken, ITransferProgress)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override Stream GetStream(
UniqueId uid,
long offset,
long count,
CancellationToken cancellationToken = default,
ITransferProgress? progress = null
)Parameters
- uid UniqueId
- The UID 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.
Implements
IMailFolderGetStream(UniqueId, Int64, Int64, CancellationToken, ITransferProgress)IMailFolderGetStream(UniqueId, 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, the stream will
end where the message ends.
Exceptions
| ArgumentException | uid is invalid. |
| ArgumentOutOfRangeException |
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. |