Mail SpoolGet Streams(Int 32, Int 32, Boolean, Cancellation Token, ITransfer Progress) Method
Get the message or header streams within the specified range.
Definition
Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The message or header streams.
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public abstract IList<Stream> GetStreams(
int startIndex,
int count,
bool headersOnly = false,
CancellationToken cancellationToken = default,
ITransferProgress? progress = null
)Parameters
- startIndex Int32
- The index of the first stream to get.
- count Int32
- The number of streams to get.
- headersOnly Boolean (Optional)
- if only the headers should be retrieved; otherwise, .
- cancellationToken CancellationToken (Optional)
- The cancellation token.
- progress ITransferProgress (Optional)
- The progress reporting mechanism.
Return Value
IListStreamThe message or header streams.
Implements
IMailSpoolGetStreams(Int32, Int32, Boolean, CancellationToken, ITransferProgress)Remarks
Gets the message or header streams within the specified range.
If the mail server supports pipelining, this method will likely be more efficient than using GetStream(Int32, Boolean, CancellationToken, ITransferProgress) for each message because it will batch the commands to reduce latency.
Exceptions
| ArgumentOutOfRangeException | startIndex and count do not specify a valid range of messages. |
| ObjectDisposedException | The MailSpool has been disposed. |
| ServiceNotConnectedException | The MailSpool is not connected. |
| ServiceNotAuthenticatedException | The MailSpool is not authenticated. |
| OperationCanceledException | The operation was canceled via the cancellation token. |
| IOException | An I/O error occurred. |
| CommandException | The command failed. |
| ProtocolException | A protocol error occurred. |