API Reference
Class
EmailMailbox
Ordered Unix mailbox aggregate.
Inheritance
- Object
- EmailMailbox
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method EmailMailbox.Load
- Method EmailMailbox.Load
- Method EmailMailbox.Load
- Method EmailMailbox.LoadAsync
- Method EmailMailbox.LoadAsync
- Property EmailMailboxReadResult.Mailbox
Accepted by parameters
- Method EmailMailboxWriter.ToBytes
- Method EmailMailboxWriter.Write
- Method EmailMailboxWriter.Write
- Method EmailMailboxWriter.WriteAsync
- Method EmailMailboxWriter.WriteAsync
Constructors
public EmailMailbox() #Methods
Load 3 overloads
public static EmailMailbox Load(String path, EmailMailboxReaderOptions options = null, CancellationToken cancellationToken = null) #Returns:
EmailMailboxLoads an mbox mailbox from a file.
Parameters
- path System.String
- options OfficeIMO.Email.EmailMailboxReaderOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static EmailMailbox Load(Byte[] bytes, EmailMailboxReaderOptions options = null, CancellationToken cancellationToken = null) #Returns:
EmailMailboxLoads an mbox mailbox from memory.
Parameters
- bytes System.Byte[]
- options OfficeIMO.Email.EmailMailboxReaderOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static EmailMailbox Load(Stream stream, EmailMailboxReaderOptions options = null, CancellationToken cancellationToken = null) #Returns:
EmailMailboxLoads from the beginning of a seekable caller-owned stream and restores its position; non-seekable streams are read forward.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Email.EmailMailboxReaderOptions = null
- cancellationToken System.Threading.CancellationToken = null
LoadAsync 2 overloads
public static async Task<EmailMailbox> LoadAsync(String path, EmailMailboxReaderOptions options = null, CancellationToken cancellationToken = null) #Returns:
Task<EmailMailbox>Asynchronously loads an mbox mailbox from a file.
Parameters
- path System.String
- options OfficeIMO.Email.EmailMailboxReaderOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static async Task<EmailMailbox> LoadAsync(Stream stream, EmailMailboxReaderOptions options = null, CancellationToken cancellationToken = null) #Returns:
Task<EmailMailbox>Asynchronously loads from the beginning of a seekable caller-owned stream and restores its position; non-seekable streams are read forward.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Email.EmailMailboxReaderOptions = null
- cancellationToken System.Threading.CancellationToken = null
Save 2 overloads
public EmailWriteResult Save(String path, EmailMailboxWriterOptions options = null) #Returns:
EmailWriteResultSaves this mailbox to a file.
Parameters
- path System.String
- options OfficeIMO.Email.EmailMailboxWriterOptions = null
public EmailWriteResult Save(Stream stream, EmailMailboxWriterOptions options = null) #Returns:
EmailWriteResultSaves this mailbox to a caller-owned stream without closing it.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Email.EmailMailboxWriterOptions = null
SaveAsync 2 overloads
public Task<EmailWriteResult> SaveAsync(String path, EmailMailboxWriterOptions options = null, CancellationToken cancellationToken = null) #Returns:
Task<EmailWriteResult>Asynchronously saves this mailbox to a file.
Parameters
- path System.String
- options OfficeIMO.Email.EmailMailboxWriterOptions = null
- cancellationToken System.Threading.CancellationToken = null
public Task<EmailWriteResult> SaveAsync(Stream stream, EmailMailboxWriterOptions options = null, CancellationToken cancellationToken = null) #Returns:
Task<EmailWriteResult>Asynchronously saves this mailbox to a caller-owned stream without closing it.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Email.EmailMailboxWriterOptions = null
- cancellationToken System.Threading.CancellationToken = null
public Byte[] ToBytes(EmailMailboxWriterOptions options = null) #Returns:
Byte[]Serializes this mailbox to mbox bytes.
Parameters
- options OfficeIMO.Email.EmailMailboxWriterOptions = null
public MemoryStream ToStream(EmailMailboxWriterOptions options = null) #Returns:
MemoryStreamSerializes the mailbox to a new writable memory stream positioned at the beginning.
Parameters
- options OfficeIMO.Email.EmailMailboxWriterOptions = null
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public IList<EmailMailboxEntry> Messages { get; } #Ordered mailbox messages.