API Reference

Cmdlet

New-OfficeEmailStoreReaderOptions

Namespace PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Email.Store.EmailStoreReaderOptions

Creates bounded email-store reader settings without requiring .NET constructor syntax.

Remarks

Creates bounded email-store reader settings without requiring .NET constructor syntax.

Examples

Authored help example

Read an EMLX message without retaining attachment payloads.

PS>


$options = New-OfficeEmailStoreReaderOptions -ExcludeAttachmentContent -MaxAttachmentsPerItem 100
            Get-OfficeEmail -Path .\Message.emlx -StoreOptions $options -AsResult
        

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

New-OfficeEmailStoreReaderOptions [-ExcludeAttachmentContent] [-IncludeAssociatedItems] [-IncludeOrphanedItems] [-MaxArchiveDecodedBytes <Int64>] [-MaxArchiveEntries <Int32>] [-MaxArchiveEntryBytes <Int64>] [-MaxAttachmentBytes <Int64>] [-MaxAttachmentsPerItem <Int32>] [-MaxBTreeDepth <Int32>] [-MaxCachedBTreePages <Int32>] [-MaxDecodedPropertyBytesPerItem <Int64>] [-MaxDecodedTableBytes <Int64>] [-MaxDirectoryDepth <Int32>] [-MaxDirectoryFileCount <Int32>] [-MaxFolderCount <Int32>] [-MaxInputBytes <Int64>] [-MaxItemCount <Int32>] [-MaxMessageBytes <Int64>] [-MaxNestedMessageDepth <Int32>] [-MaxNodeCount <Int32>] [-MaxPropertiesPerItem <Int32>] [-MaxTotalAttachmentBytes <Int64>] [-MaxXmlCharactersPerItem <Int64>] [-PstPassword <String>] [-PstPasswordEncoding <String>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

ExcludeAttachmentContent SwitchParameter optionalposition: namedpipeline: False
Do not retain decoded attachment payloads in memory.
IncludeAssociatedItems SwitchParameter optionalposition: namedpipeline: False
Materialize folder-associated information items.
IncludeOrphanedItems SwitchParameter optionalposition: namedpipeline: False
Recover item nodes absent from folder contents tables.
MaxArchiveDecodedBytes Int64 optionalposition: namedpipeline: False
Maximum total decoded size declared by archive entries.
MaxArchiveEntries Int32 optionalposition: namedpipeline: False
Maximum entries accepted from a compressed email-store archive.
MaxArchiveEntryBytes Int64 optionalposition: namedpipeline: False
Maximum decoded size declared by one archive entry.
MaxAttachmentBytes Int64 optionalposition: namedpipeline: False
Maximum decoded bytes in one attachment.
MaxAttachmentsPerItem Int32 optionalposition: namedpipeline: False
Maximum attachments per item.
MaxBTreeDepth Int32 optionalposition: namedpipeline: False
Maximum tree traversal depth.
MaxCachedBTreePages Int32 optionalposition: namedpipeline: False
Maximum PST/OST B-tree pages retained by the cache.
MaxDecodedPropertyBytesPerItem Int64 optionalposition: namedpipeline: False
Maximum decoded property bytes per item.
MaxDecodedTableBytes Int64 optionalposition: namedpipeline: False
Maximum decoded bytes traversed from one PST/OST table data tree.
MaxDirectoryDepth Int32 optionalposition: namedpipeline: False
Maximum directory depth traversed by mailbox-directory sessions.
MaxDirectoryFileCount Int32 optionalposition: namedpipeline: False
Maximum EML, EMLX, and Maildir files indexed by one directory session.
MaxFolderCount Int32 optionalposition: namedpipeline: False
Maximum folders materialized.
MaxInputBytes Int64 optionalposition: namedpipeline: False
Maximum seekable source length.
MaxItemCount Int32 optionalposition: namedpipeline: False
Maximum items materialized.
MaxMessageBytes Int64 optionalposition: namedpipeline: False
Maximum RFC 5322/MIME message bytes accepted from one item.
MaxNestedMessageDepth Int32 optionalposition: namedpipeline: False
Maximum embedded-message recursion depth.
MaxNodeCount Int32 optionalposition: namedpipeline: False
Maximum NDB nodes and blocks visited.
MaxPropertiesPerItem Int32 optionalposition: namedpipeline: False
Maximum MAPI properties decoded per item.
MaxTotalAttachmentBytes Int64 optionalposition: namedpipeline: False
Maximum decoded attachment bytes across the read.
MaxXmlCharactersPerItem Int64 optionalposition: namedpipeline: False
Maximum XML characters parsed from one archive item.
PstPassword String optionalposition: namedpipeline: False
Password used to validate legacy protected PST files.
PstPasswordEncoding String optionalposition: namedpipeline: False
Encoding name used for the legacy PST password checksum.

Outputs

OfficeIMO.Email.Store.EmailStoreReaderOptions