Mime EntityWrite To(Format Options, Stream, Boolean, Cancellation Token) Method
Write the MimeEntity to the specified output stream.
Definition
Namespace: MimeKit
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
C#
public void WriteTo(
FormatOptions options,
Stream stream,
bool contentOnly,
CancellationToken cancellationToken = default
)Parameters
- options FormatOptions
- The formatting options.
- stream Stream
- The output stream.
- contentOnly Boolean
- if only the content should be written; otherwise, .
- cancellationToken CancellationToken (Optional)
- The cancellation token.
Implements
IMimeEntityWriteTo(FormatOptions, Stream, Boolean, CancellationToken)Remarks
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. |