Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

EmailStoreReaderOptions

Namespace OfficeIMO.Email.Store
Assembly OfficeIMO.Email
Source revision 804a7612eee4 with working tree changes
Modifiers sealed

Safety and materialization limits for email-store readers.

Inheritance

  • Object
  • EmailStoreReaderOptions

Usage

Explore 9 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 6

Constructors

EmailStoreReaderOptions 2 overloads
public EmailStoreReaderOptions(Int64 maxInputBytes = 1099511627776, Int32 maxNodeCount = 25000000, Int32 maxBTreeDepth = 32, Int32 maxCachedBTreePages = 512, Int32 maxFolderCount = 100000, Int32 maxItemCount = 1000000, Int32 maxPropertiesPerItem = 16384, Int64 maxDecodedPropertyBytesPerItem = 134217728, Int32 maxAttachmentsPerItem = 10000, Int64 maxAttachmentBytes = 536870912, Int64 maxTotalAttachmentBytes = 4294967296, Boolean retainAttachmentContent = true, String? pstPassword = null, Encoding? pstPasswordEncoding = null, Boolean includeAssociatedItems = false, Boolean includeOrphanedItems = false, Int32 maxNestedMessageDepth = 16, Int32 maxArchiveEntries = 500000, Int64 maxArchiveEntryBytes = 536870912, Int64 maxArchiveDecodedBytes = 8589934592, Int64 maxXmlCharactersPerItem = 67108864, Int64 maxMessageBytes = 268435456, Int32 maxDirectoryDepth = 64, Int32 maxDirectoryFileCount = 1000000, Int64 maxDecodedTableBytes = 8589934592, Int32 maxDirectoryEntryCount = 2000000) #

Creates bounded reader options.

Parameters

maxInputBytes System.Int64 = 1099511627776 optionalposition: 0
maxNodeCount System.Int32 = 25000000 optionalposition: 1
maxBTreeDepth System.Int32 = 32 optionalposition: 2
maxCachedBTreePages System.Int32 = 512 optionalposition: 3
maxFolderCount System.Int32 = 100000 optionalposition: 4
maxItemCount System.Int32 = 1000000 optionalposition: 5
maxPropertiesPerItem System.Int32 = 16384 optionalposition: 6
maxDecodedPropertyBytesPerItem System.Int64 = 134217728 optionalposition: 7
maxAttachmentsPerItem System.Int32 = 10000 optionalposition: 8
maxAttachmentBytes System.Int64 = 536870912 optionalposition: 9
maxTotalAttachmentBytes System.Int64 = 4294967296 optionalposition: 10
retainAttachmentContent System.Boolean = true optionalposition: 11
pstPassword System.String? = null optionalposition: 12
pstPasswordEncoding System.Text.Encoding? = null optionalposition: 13
includeAssociatedItems System.Boolean = false optionalposition: 14
includeOrphanedItems System.Boolean = false optionalposition: 15
maxNestedMessageDepth System.Int32 = 16 optionalposition: 16
maxArchiveEntries System.Int32 = 500000 optionalposition: 17
maxArchiveEntryBytes System.Int64 = 536870912 optionalposition: 18
maxArchiveDecodedBytes System.Int64 = 8589934592 optionalposition: 19
maxXmlCharactersPerItem System.Int64 = 67108864 optionalposition: 20
maxMessageBytes System.Int64 = 268435456 optionalposition: 21
maxDirectoryDepth System.Int32 = 64 optionalposition: 22
maxDirectoryFileCount System.Int32 = 1000000 optionalposition: 23
maxDecodedTableBytes System.Int64 = 8589934592 optionalposition: 24
maxDirectoryEntryCount System.Int32 = 2000000 optionalposition: 25
public EmailStoreReaderOptions(Int64 maxInputBytes, Int32 maxNodeCount, Int32 maxBTreeDepth, Int32 maxCachedBTreePages, Int32 maxFolderCount, Int32 maxItemCount, Int32 maxPropertiesPerItem, Int64 maxDecodedPropertyBytesPerItem, Int32 maxAttachmentsPerItem, Int64 maxAttachmentBytes, Int64 maxTotalAttachmentBytes, Boolean retainAttachmentContent, String? pstPassword, Encoding? pstPasswordEncoding, Boolean includeAssociatedItems, Boolean includeOrphanedItems, Int32 maxNestedMessageDepth, Int32 maxArchiveEntries, Int64 maxArchiveEntryBytes, Int64 maxArchiveDecodedBytes, Int64 maxXmlCharactersPerItem, Int64 maxMessageBytes, Int32 maxDirectoryDepth, Int32 maxDirectoryFileCount, Int64 maxDecodedTableBytes) #

Creates options using the original constructor contract with the default directory-entry bound.

Parameters

maxInputBytes System.Int64 requiredposition: 0
maxNodeCount System.Int32 requiredposition: 1
maxBTreeDepth System.Int32 requiredposition: 2
maxCachedBTreePages System.Int32 requiredposition: 3
maxFolderCount System.Int32 requiredposition: 4
maxItemCount System.Int32 requiredposition: 5
maxPropertiesPerItem System.Int32 requiredposition: 6
maxDecodedPropertyBytesPerItem System.Int64 requiredposition: 7
maxAttachmentsPerItem System.Int32 requiredposition: 8
maxAttachmentBytes System.Int64 requiredposition: 9
maxTotalAttachmentBytes System.Int64 requiredposition: 10
retainAttachmentContent System.Boolean requiredposition: 11
pstPassword System.String? requiredposition: 12
pstPasswordEncoding System.Text.Encoding? requiredposition: 13
includeAssociatedItems System.Boolean requiredposition: 14
includeOrphanedItems System.Boolean requiredposition: 15
maxNestedMessageDepth System.Int32 requiredposition: 16
maxArchiveEntries System.Int32 requiredposition: 17
maxArchiveEntryBytes System.Int64 requiredposition: 18
maxArchiveDecodedBytes System.Int64 requiredposition: 19
maxXmlCharactersPerItem System.Int64 requiredposition: 20
maxMessageBytes System.Int64 requiredposition: 21
maxDirectoryDepth System.Int32 requiredposition: 22
maxDirectoryFileCount System.Int32 requiredposition: 23
maxDecodedTableBytes System.Int64 requiredposition: 24

Properties

public static EmailStoreReaderOptions Default { get; } #

Default bounded options.

public Int64 MaxInputBytes { get; } #

Maximum seekable source length.

public Int32 MaxNodeCount { get; } #

Maximum NDB nodes and blocks visited.

public Int32 MaxBTreeDepth { get; } #

Maximum tree traversal depth.

public Int32 MaxCachedBTreePages { get; } #

Maximum PST/OST B-tree pages retained by the bounded random-access cache.

public Int32 MaxFolderCount { get; } #

Maximum folders materialized.

public Int32 MaxItemCount { get; } #

Maximum items materialized.

public Int32 MaxPropertiesPerItem { get; } #

Maximum MAPI properties decoded per item.

public Int64 MaxDecodedPropertyBytesPerItem { get; } #

Maximum decoded property bytes per item.

public Int32 MaxAttachmentsPerItem { get; } #

Maximum attachments per item.

public Int64 MaxAttachmentBytes { get; } #

Maximum decoded bytes in one attachment.

public Int64 MaxTotalAttachmentBytes { get; } #

Maximum decoded attachment bytes across the read.

public Boolean RetainAttachmentContent { get; } #

Whether attachment payloads are retained in memory.

public String? PstPassword { get; } #

Password to validate when PidTagPstPassword is nonzero. The value is never logged or retained by results.

public Encoding PstPasswordEncoding { get; } #

Byte encoding used for the legacy PST password checksum. Defaults to ASCII.

public Boolean IncludeAssociatedItems { get; } #

Whether folder-associated information items are materialized separately from visible items.

public Boolean IncludeOrphanedItems { get; } #

Whether NBT item nodes absent from folder contents tables are recovered using their parent links.

public Int32 MaxNestedMessageDepth { get; } #

Maximum embedded-message recursion depth. Zero preserves the attachment without projecting its item.

public Int32 MaxArchiveEntries { get; } #

Maximum entries accepted from a compressed email-store archive.

public Int64 MaxArchiveEntryBytes { get; } #

Maximum decoded size declared by one compressed archive entry.

public Int64 MaxArchiveDecodedBytes { get; } #

Maximum total decoded size declared by all compressed archive entries.

public Int64 MaxXmlCharactersPerItem { get; } #

Maximum XML characters parsed from one archive item.

public Int64 MaxMessageBytes { get; } #

Maximum RFC 5322/MIME message bytes accepted from one store item.

public Int32 MaxDirectoryDepth { get; } #

Maximum directory depth traversed by mailbox-directory sessions.

public Int32 MaxDirectoryFileCount { get; } #

Maximum message and identified Apple attachment-storage files indexed by one mailbox-directory session.

public Int64 MaxDecodedTableBytes { get; } #

Maximum decoded bytes traversed from one PST/OST table data tree.

public Int32 MaxDirectoryEntryCount { get; } #

Maximum filesystem entries visited, including directories, sidecars and unrelated files.