API Reference

Class

EmailStorePstWriterOptions

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

Controls creation of a new managed Unicode PST file.

Inheritance

  • Object
  • EmailStorePstWriterOptions

Usage

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

Accepted by parameters

Constructors

public EmailStorePstWriterOptions(String displayName = null, Boolean overwriteExisting = false, Boolean failOnDataLoss = false, Int32 maxFolderCount = 100000, Int32 maxItemCount = 2147483647, Int32 maxNestedMessageDepth = 32, String checkpointPath = null, Int32 checkpointIntervalItems = 1000, Int32 maxIndexRecordsInMemory = 65536, Boolean retainCheckpointOnDispose = true, Int32 maxDiagnostics = 10000, IProgress<EmailStorePstWriteProgress> progress = null) #

Creates PST writer options.

Parameters

displayName System.String = null optionalposition: 0
overwriteExisting System.Boolean = false optionalposition: 1
failOnDataLoss System.Boolean = false optionalposition: 2
maxFolderCount System.Int32 = 100000 optionalposition: 3
maxItemCount System.Int32 = 2147483647 optionalposition: 4
maxNestedMessageDepth System.Int32 = 32 optionalposition: 5
checkpointPath System.String = null optionalposition: 6
checkpointIntervalItems System.Int32 = 1000 optionalposition: 7
maxIndexRecordsInMemory System.Int32 = 65536 optionalposition: 8
retainCheckpointOnDispose System.Boolean = true optionalposition: 9
maxDiagnostics System.Int32 = 10000 optionalposition: 10
progress System.IProgress{OfficeIMO.Email.Store.EmailStorePstWriteProgress} = null optionalposition: 11

Properties

public String DisplayName { get; } #

Display name stored in the message-store object.

public Boolean OverwriteExisting { get; } #

Whether an existing destination may be atomically replaced.

public Boolean FailOnDataLoss { get; } #

Whether a fidelity warning prevents completion.

public Int32 MaxFolderCount { get; } #

Maximum folders accepted by one writer.

public Int32 MaxItemCount { get; } #

Maximum top-level items accepted by one writer.

public Int32 MaxNestedMessageDepth { get; } #

Maximum embedded-message nesting depth written.

public String CheckpointPath { get; } #

Optional durable state file used by EmailStorePstWriteProgress>).

public Int32 CheckpointIntervalItems { get; } #

Number of newly accepted items between automatic durable checkpoints.

public Int32 MaxIndexRecordsInMemory { get; } #

Maximum fixed index records sorted in managed memory at one time.

public Boolean RetainCheckpointOnDispose { get; } #

Whether an incomplete writer preserves or creates its checkpoint when disposed.

public Int32 MaxDiagnostics { get; } #

Maximum detailed diagnostics retained in managed memory and checkpoints.

public IProgress<EmailStorePstWriteProgress> Progress { get; } #

Optional progress sink. Reports contain counts and paths, never message content.