API Reference
EmailMailboxReader
Reads mboxo and mboxrd mailbox aggregates.
Inheritance
- Object
- EmailMailboxReader
Constructors
Methods
public EmailMailboxReadResult Read(String filePath, CancellationToken cancellationToken = null) #EmailMailboxReadResultReads a mailbox file.
Parameters
- filePath System.String
- cancellationToken System.Threading.CancellationToken = null
public EmailMailboxReadResult Read(Byte[] data, CancellationToken cancellationToken = null) #EmailMailboxReadResultReads mailbox bytes.
Parameters
- data System.Byte[]
- cancellationToken System.Threading.CancellationToken = null
public EmailMailboxReadResult Read(Stream stream, CancellationToken cancellationToken = null) #EmailMailboxReadResultReads without closing the stream. Seekable streams are read from the beginning and restored to their original position; non-seekable streams are read forward from their current position.
Parameters
- stream System.IO.Stream
- cancellationToken System.Threading.CancellationToken = null
public async Task<EmailMailboxReadResult> ReadAsync(String filePath, CancellationToken cancellationToken = null) #Task<EmailMailboxReadResult>Asynchronously reads a mailbox file.
Parameters
- filePath System.String
- cancellationToken System.Threading.CancellationToken = null
public async Task<EmailMailboxReadResult> ReadAsync(Stream stream, CancellationToken cancellationToken = null) #Task<EmailMailboxReadResult>Asynchronously reads without closing the stream. Seekable streams are read from the beginning and restored to their original position; non-seekable streams are read forward.
Parameters
- stream System.IO.Stream
- cancellationToken System.Threading.CancellationToken = null
public IEnumerable<EmailMailboxEntryReadResult> ReadEntries(String filePath, CancellationToken cancellationToken = null) #IEnumerable<EmailMailboxEntryReadResult>Enumerates a mailbox file while retaining at most one decoded message in memory.
Parameters
- filePath System.String
- cancellationToken System.Threading.CancellationToken = null
public IEnumerable<EmailMailboxEntryReadResult> ReadEntries(Stream stream, CancellationToken cancellationToken = null) #IEnumerable<EmailMailboxEntryReadResult>Enumerates a caller-owned mailbox stream while retaining at most one decoded message in memory. Seekable streams are restored to their original position when enumeration ends or is disposed.
Parameters
- stream System.IO.Stream
- cancellationToken System.Threading.CancellationToken = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public EmailMailboxReaderOptions Options { get; } #Reader policy used by this instance.