Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 565 stars PSWriteOfficePowerShell module 165 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

EmailStoreItemReader

Edit on GitHub
Namespace OfficeIMO.Reader.Email
Assembly OfficeIMO.Reader.Email
Source ../../../../_/OfficeIMO.Reader.Email/EmailStoreItemReader.cs:17
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) #
../../../../_/OfficeIMO.Reader.Email/EmailStoreItemReader.cs:17
Returns: IEnumerable<ReaderEmailStoreItemResult>

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 System.String requiredposition: 0
readerOptions OfficeIMO.Reader.ReaderOptions = null optionalposition: 1
emailStoreOptions OfficeIMO.Reader.Email.ReaderEmailStoreOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = default optionalposition: 3
public static IEnumerable<ReaderEmailStoreItemResult> Read(OfficeDocumentReader reader, String path, ReaderOptions readerOptions = null, ReaderEmailStoreOptions emailStoreOptions = null, CancellationToken cancellationToken = default) #
../../../../_/OfficeIMO.Reader.Email/EmailStoreItemReader.cs:31
Returns: IEnumerable<ReaderEmailStoreItemResult>

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 requiredposition: 0
path System.String requiredposition: 1
readerOptions OfficeIMO.Reader.ReaderOptions = null optionalposition: 2
emailStoreOptions OfficeIMO.Reader.Email.ReaderEmailStoreOptions = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = default optionalposition: 4
public static ReaderEmailStoreItemResult ReadById(OfficeDocumentReader reader, String path, String itemId, ReaderOptions readerOptions = null, ReaderEmailStoreOptions emailStoreOptions = null, CancellationToken cancellationToken = default) #
../../../../_/OfficeIMO.Reader.Email/EmailStoreItemReader.cs:49
Returns: ReaderEmailStoreItemResult

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 requiredposition: 0
path System.String requiredposition: 1
itemId System.String requiredposition: 2
readerOptions OfficeIMO.Reader.ReaderOptions = null optionalposition: 3
emailStoreOptions OfficeIMO.Reader.Email.ReaderEmailStoreOptions = null optionalposition: 4
cancellationToken System.Threading.CancellationToken = default optionalposition: 5