Pop 3ClientGet Stream Async Method
Asynchronously get the message or header stream at the specified index.
Definition
Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
The message or header stream.
IMailSpoolGetStreamAsync(Int32, Boolean, CancellationToken, ITransferProgress)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override Task<Stream> GetStreamAsync(
int index,
bool headersOnly = false,
CancellationToken cancellationToken = default,
ITransferProgress? progress = null
)Parameters
- index Int32
- The index of the message.
- 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
TaskStreamThe message or header stream.
Implements
IMailSpoolGetStreamAsync(Int32, Boolean, CancellationToken, ITransferProgress)IMailSpoolGetStreamAsync(Int32, Boolean, CancellationToken, ITransferProgress)
Remarks
Gets the message or header stream at the specified index.
Exceptions
| ArgumentOutOfRangeException | index is not a valid message index. |
| ObjectDisposedException | The Pop3Client has been disposed. |
| ServiceNotConnectedException | The Pop3Client is not connected. |
| ServiceNotAuthenticatedException | The Pop3Client is not authenticated. |
| OperationCanceledException | The operation was canceled via the cancellation token. |
| IOException | An I/O error occurred. |
| Pop3CommandException | The POP3 command failed. |
| Pop3ProtocolException | A POP3 protocol error occurred. |