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
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
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
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public EmailWriterOptions Options { get; } #Writer policy used by this instance.