Mime EntityWrite To Async(Format Options, Stream, Cancellation Token) Method
Asynchronously write the MimeEntity to the specified output stream.
Definition
Namespace: MimeKit
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
An awaitable task.
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
C#
public Task WriteToAsync(
FormatOptions options,
Stream stream,
CancellationToken cancellationToken = default
)Parameters
- options FormatOptions
- The formatting options.
- stream Stream
- The output stream.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
Return Value
TaskAn awaitable task.
Implements
IMimeEntityWriteToAsync(FormatOptions, Stream, CancellationToken)Remarks
Asynchronously writes the headers to the output stream, followed by a blank line, and then the content of the entity (including all of its descendants in the case of a Multipart or a MessagePart).
Deeply nested entities are written without recursion, so the nesting depth of the entity cannot exhaust the call stack.
Exceptions
| ArgumentNullException |
options is . -or- stream is . |
| ObjectDisposedException | The MimeEntity has been disposed. |
| OperationCanceledException | The operation was canceled via the cancellation token. |
| IOException | An I/O error occurred. |