API Reference
Class
EmailMailboxWriter
Writes deterministic mboxo or mboxrd mailbox aggregates.
Inheritance
- Object
- EmailMailboxWriter
Constructors
Methods
public Byte[] ToBytes(EmailMailbox mailbox) #Returns:
Byte[]Writes a mailbox to memory.
Parameters
- mailbox OfficeIMO.Email.EmailMailbox
Write 2 overloads
public EmailWriteResult Write(EmailMailbox mailbox, String filePath) #Returns:
EmailWriteResultWrites a mailbox to a file.
Parameters
- mailbox OfficeIMO.Email.EmailMailbox
- filePath System.String
public EmailWriteResult Write(EmailMailbox mailbox, Stream stream) #Returns:
EmailWriteResultWrites a mailbox to a stream without closing it.
Parameters
- mailbox OfficeIMO.Email.EmailMailbox
- stream System.IO.Stream
WriteAsync 2 overloads
public async Task<EmailWriteResult> WriteAsync(EmailMailbox mailbox, String filePath, CancellationToken cancellationToken = null) #Returns:
Task<EmailWriteResult>Asynchronously writes a mailbox file.
Parameters
- mailbox OfficeIMO.Email.EmailMailbox
- filePath System.String
- cancellationToken System.Threading.CancellationToken = null
public async Task<EmailWriteResult> WriteAsync(EmailMailbox mailbox, Stream stream, CancellationToken cancellationToken = null) #Returns:
Task<EmailWriteResult>Asynchronously writes a mailbox without closing the stream.
Parameters
- mailbox OfficeIMO.Email.EmailMailbox
- stream System.IO.Stream
- cancellationToken System.Threading.CancellationToken = null
public EmailWriteResult WriteEntries(IEnumerable<EmailMailboxEntry> entries, Stream stream, CancellationToken cancellationToken = null) #Returns:
EmailWriteResultWrites an entry sequence directly to a caller-owned stream while retaining at most one serialized message. A limit or enumeration failure can leave already completed entries in the destination.
Parameters
- entries System.Collections.Generic.IEnumerable{OfficeIMO.Email.EmailMailboxEntry}
- stream System.IO.Stream
- cancellationToken System.Threading.CancellationToken = null
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public EmailMailboxWriterOptions Options { get; } #Writer policy used by this instance.