Click or drag to resize
MimeKit

Pop3ClientGetStreamAsync Method

Asynchronously get the message or header stream at the specified index.

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
Copy
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)
true if only the headers should be retrieved; otherwise, false.
cancellationToken  CancellationToken  (Optional)
The cancellation token.
progress  ITransferProgress  (Optional)
The progress reporting mechanism.

Return Value

TaskStream
The message or header stream.

Implements

IMailSpoolGetStreamAsync(Int32, Boolean, CancellationToken, ITransferProgress)
IMailSpoolGetStreamAsync(Int32, Boolean, CancellationToken, ITransferProgress)
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionindex 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.
Remarks
Gets the message or header stream at the specified index.
See Also