API Reference

Class

EmailStorePstCompactionOptions

Namespace OfficeIMO.Email.Store
Assembly OfficeIMO.Email
Modifiers sealed

Selection, estimation, fidelity, and verification policy for a safe PST rewrite compaction.

Inheritance

  • Object
  • EmailStorePstCompactionOptions

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

Accepted by parameters

Constructors

public EmailStorePstCompactionOptions(Boolean overwriteExisting = false, Boolean failOnDataLoss = true, Boolean continueOnItemError = false, Boolean includeAssociatedItems = true, Boolean includeOrphanedItems = true, Boolean includeSearchFolders = false, Int32 maxItems = 1000000, Int32 maxNestedMessageDepth = 32, Int64 unknownItemEstimateBytes = 1048576, Int64 perItemOverheadBytes = 16384, Int64 fixedPstOverheadBytes = 1048576, String displayName = null, EmailSemanticComparisonOptions verificationOptions = null, Int32 maxVerificationIssues = 1000) #

Creates compaction options.

Parameters

overwriteExisting System.Boolean = false optionalposition: 0
failOnDataLoss System.Boolean = true optionalposition: 1
continueOnItemError System.Boolean = false optionalposition: 2
includeAssociatedItems System.Boolean = true optionalposition: 3
includeOrphanedItems System.Boolean = true optionalposition: 4
includeSearchFolders System.Boolean = false optionalposition: 5
maxItems System.Int32 = 1000000 optionalposition: 6
maxNestedMessageDepth System.Int32 = 32 optionalposition: 7
unknownItemEstimateBytes System.Int64 = 1048576 optionalposition: 8
perItemOverheadBytes System.Int64 = 16384 optionalposition: 9
fixedPstOverheadBytes System.Int64 = 1048576 optionalposition: 10
displayName System.String = null optionalposition: 11
verificationOptions OfficeIMO.Email.EmailSemanticComparisonOptions = null optionalposition: 12
maxVerificationIssues System.Int32 = 1000 optionalposition: 13

Properties

public Boolean OverwriteExisting { get; } #

Whether an existing distinct destination may be atomically replaced after verification.

public Boolean FailOnDataLoss { get; } #

Whether any fidelity warning/error blocks destination commit.

public Boolean ContinueOnItemError { get; } #

Whether an unreadable item is reported and skipped.

public Boolean IncludeAssociatedItems { get; } #

Whether folder-associated information items are retained.

public Boolean IncludeOrphanedItems { get; } #

Whether readable source-index orphans are recovered into the compacted output.

public Boolean IncludeSearchFolders { get; } #

Whether search folders are retained as static folders.

public Int32 MaxItems { get; } #

Maximum source references scanned and written.

public Int32 MaxNestedMessageDepth { get; } #

Maximum embedded-item depth read and written.

public Int64 UnknownItemEstimateBytes { get; } #

Planning estimate for items without a declared source size.

public Int64 PerItemOverheadBytes { get; } #

Planning estimate for per-item PST rows, nodes, and indexes.

public Int64 FixedPstOverheadBytes { get; } #

Planning estimate for fixed PST structures and allocation maps.

public String DisplayName { get; } #

Optional destination display name.

public EmailSemanticComparisonOptions VerificationOptions { get; } #

Optional semantic verification policy.

public Int32 MaxVerificationIssues { get; } #

Maximum mismatch/failure details retained.