API Reference
Class
EmailDocumentWriter
Serializes EmailDocument instances into deterministic email artifacts.
Inheritance
- Object
- EmailDocumentWriter
Constructors
Methods
public EmailConversionReport AnalyzeConversion(EmailDocument document, EmailFileFormat format = Eml) #Returns:
EmailConversionReportAnalyzes known fidelity implications without producing output.
Parameters
- document OfficeIMO.Email.EmailDocument
- format OfficeIMO.Email.EmailFileFormat = Eml
ToBytes 2 overloads
public Byte[] ToBytes(EmailDocument document, EmailFileFormat format = Eml) #Returns:
Byte[]Writes an artifact to memory.
Parameters
- document OfficeIMO.Email.EmailDocument
- format OfficeIMO.Email.EmailFileFormat = Eml
public Byte[] ToBytes(EmailDocument document, EmailFileFormat format, out EmailWriteResult result) #Returns:
Byte[]Writes an artifact to memory and returns the same preservation, lifetime, diagnostic, and loss evidence used by file and stream writes. Attachment sources are fully consumed within this call and are not retained.
Parameters
- document OfficeIMO.Email.EmailDocument
- format OfficeIMO.Email.EmailFileFormat
- result OfficeIMO.Email.EmailWriteResult@
Write 2 overloads
public EmailWriteResult Write(EmailDocument document, String filePath, EmailFileFormat format = Eml) #Returns:
EmailWriteResultWrites an artifact to a file.
Parameters
- document OfficeIMO.Email.EmailDocument
- filePath System.String
- format OfficeIMO.Email.EmailFileFormat = Eml
public EmailWriteResult Write(EmailDocument document, Stream stream, EmailFileFormat format = Eml) #Returns:
EmailWriteResultWrites an artifact to a stream without closing it.
Parameters
- document OfficeIMO.Email.EmailDocument
- stream System.IO.Stream
- format OfficeIMO.Email.EmailFileFormat = Eml
WriteAsync 2 overloads
public async Task<EmailWriteResult> WriteAsync(EmailDocument document, String filePath, EmailFileFormat format = Eml, CancellationToken cancellationToken = null) #Returns:
Task<EmailWriteResult>Asynchronously writes an artifact to a file.
Parameters
- document OfficeIMO.Email.EmailDocument
- filePath System.String
- format OfficeIMO.Email.EmailFileFormat = Eml
- cancellationToken System.Threading.CancellationToken = null
public async Task<EmailWriteResult> WriteAsync(EmailDocument document, Stream stream, EmailFileFormat format = Eml, CancellationToken cancellationToken = null) #Returns:
Task<EmailWriteResult>Asynchronously writes an artifact to a stream without closing it.
Parameters
- document OfficeIMO.Email.EmailDocument
- stream System.IO.Stream
- format OfficeIMO.Email.EmailFileFormat = Eml
- cancellationToken System.Threading.CancellationToken = null
Inherited Methods
Properties
public EmailWriterOptions Options { get; } #Writer policy used by this instance.