API Reference

Class

EmailStoreExportOptions

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

Selection, format, and failure policy for item-by-item directory export.

Inheritance

  • Object
  • EmailStoreExportOptions

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 EmailStoreExportOptions(EmailFileFormat format = Eml, String folderId = null, Boolean includeDescendants = false, Boolean includeAssociatedItems = false, Boolean includeOrphanedItems = false, Boolean preserveFolderHierarchy = true, Boolean overwriteExisting = false, Boolean continueOnError = true, Boolean writeManifest = true, Int32 maxItems = 100000, EmailWriterOptions writerOptions = null) #

Creates export options.

Parameters

format OfficeIMO.Email.EmailFileFormat = Eml optionalposition: 0
folderId System.String = null optionalposition: 1
includeDescendants System.Boolean = false optionalposition: 2
includeAssociatedItems System.Boolean = false optionalposition: 3
includeOrphanedItems System.Boolean = false optionalposition: 4
preserveFolderHierarchy System.Boolean = true optionalposition: 5
overwriteExisting System.Boolean = false optionalposition: 6
continueOnError System.Boolean = true optionalposition: 7
writeManifest System.Boolean = true optionalposition: 8
maxItems System.Int32 = 100000 optionalposition: 9
writerOptions OfficeIMO.Email.EmailWriterOptions = null optionalposition: 10

Properties

public EmailFileFormat Format { get; } #

Destination artifact format.

public String FolderId { get; } #

Optional source folder identifier. Null exports every folder.

public Boolean IncludeDescendants { get; } #

Whether descendants of FolderId are included.

public Boolean IncludeAssociatedItems { get; } #

Whether folder-associated information items are exported.

public Boolean IncludeOrphanedItems { get; } #

Whether recoverable items absent from contents tables are exported.

public Boolean PreserveFolderHierarchy { get; } #

Whether the source folder hierarchy is represented in destination directories.

public Boolean OverwriteExisting { get; } #

Whether an existing artifact with the same stable source identifier may be replaced.

public Boolean ContinueOnError { get; } #

Whether export continues after an item read or write failure.

public Boolean WriteManifest { get; } #

Whether a tab-separated preservation manifest is written after the export.

public Int32 MaxItems { get; } #

Maximum item references attempted.

public EmailWriterOptions WriterOptions { get; } #

Underlying OfficeIMO.Email conversion and output policy.