Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

EmailStoreItemReader

OfficeIMO.Reader.Email

Namespace
OfficeIMO.Reader.Email
Assembly
OfficeIMO.Reader.Email
Source revision
ba882f6b0d07 with working tree changes
Modifiers
static

Item-at-a-time Reader ingestion for bounded PST, OST, OLM, EMLX, and mailbox-directory sessions.

Inheritance

  • object
  • EmailStoreItemReader

Methods

Read 2 overloads
public static IEnumerable<ReaderEmailStoreItemResult> Read(string path, ReaderOptions? readerOptions = null, ReaderEmailStoreOptions? emailStoreOptions = null, CancellationToken cancellationToken = default) #

Lazily selects and projects one store item at a time. The source session and deferred attachment streams remain open only for the lifetime of the returned enumeration.

Parameters

path string required
readerOptions OfficeIMO.Reader.ReaderOptions? = null optional
emailStoreOptions OfficeIMO.Reader.Email.ReaderEmailStoreOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

IEnumerable<ReaderEmailStoreItemResult>
public static IEnumerable<ReaderEmailStoreItemResult> Read(OfficeDocumentReader reader, string path, ReaderOptions? readerOptions = null, ReaderEmailStoreOptions? emailStoreOptions = null, CancellationToken cancellationToken = default) #

Lazily selects and projects one store item at a time through the supplied Reader's configured HTML, RTF, attachment, and other modular handlers.

Parameters

reader OfficeIMO.Reader.OfficeDocumentReader required
path string required
readerOptions OfficeIMO.Reader.ReaderOptions? = null optional
emailStoreOptions OfficeIMO.Reader.Email.ReaderEmailStoreOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

IEnumerable<ReaderEmailStoreItemResult>
public static ReaderEmailStoreItemResult ReadById(OfficeDocumentReader reader, string path, string itemId, ReaderOptions? readerOptions = null, ReaderEmailStoreOptions? emailStoreOptions = null, CancellationToken cancellationToken = default) #

Reads and projects one explicitly selected store item by its stable source identifier. References are enumerated as lightweight rows until the requested identifier is found; unrelated item bodies and attachment payloads are not materialized.

Parameters

reader OfficeIMO.Reader.OfficeDocumentReader required
path string required
itemId string required
readerOptions OfficeIMO.Reader.ReaderOptions? = null optional
emailStoreOptions OfficeIMO.Reader.Email.ReaderEmailStoreOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional