Get Started

API Reference

Cmdlet

New-OfficeEmailReaderOptions

Namespace PSWriteOffice
Inputs
None
Outputs
OfficeIMO.Email.EmailReaderOptions
Source
Sources/PSWriteOffice/Cmdlets/Email/NewOfficeEmailReaderOptionsCommand.cs:15 Edit on GitHub

Creates bounded EML, MSG, and TNEF reader settings through ordinary PowerShell parameters.

Remarks

Creates bounded EML, MSG, and TNEF reader settings through ordinary PowerShell parameters.

Examples

Authored help example

Read message diagnostics without retaining attachment payloads.

PS>


$options = New-OfficeEmailReaderOptions -ExcludeAttachmentContent -MaxAttachmentBytes 25MB
            Get-OfficeEmail -Path .\Message.msg -Options $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-OfficeEmailReaderOptions [-ExcludeAttachmentContent] [-MaxAttachmentBytes <Int64>] [-MaxAttachmentCount <Int32>] [-MaxCompoundDirectoryEntries <Int32>] [-MaxDecodedPropertyBytes <Int64>] [-MaxHeaderBytes <Int32>] [-MaxHeaderCount <Int32>] [-MaxInputBytes <Int64>] [-MaxMapiPropertyCount <Int32>] [-MaxMimeDepth <Int32>] [-MaxNestedMessageDepth <Int32>] [-MaxPartCount <Int32>] [-MaxTnefAttributeCount <Int32>] [-MaxTotalAttachmentBytes <Int64>] [-PreserveRawSource] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

ExcludeAttachmentContent SwitchParameter optionalposition: namedpipeline: False
Do not retain decoded attachment payloads in memory.
MaxAttachmentBytes Int64 optionalposition: namedpipeline: False
Maximum decoded bytes for one attachment.
MaxAttachmentCount Int32 optionalposition: namedpipeline: False
Maximum aggregate attachment count.
MaxCompoundDirectoryEntries Int32 optionalposition: namedpipeline: False
Maximum CFB directory entries accepted while reading MSG.
MaxDecodedPropertyBytes Int64 optionalposition: namedpipeline: False
Maximum aggregate bytes represented by decoded MSG property streams.
MaxHeaderBytes Int32 optionalposition: namedpipeline: False
Maximum bytes allowed in one MIME header section.
MaxHeaderCount Int32 optionalposition: namedpipeline: False
Maximum number of header fields in one entity.
MaxInputBytes Int64 optionalposition: namedpipeline: False
Maximum artifact size accepted by the reader.
MaxMapiPropertyCount Int32 optionalposition: namedpipeline: False
Maximum aggregate MAPI properties across a message and embedded messages.
MaxMimeDepth Int32 optionalposition: namedpipeline: False
Maximum nested MIME depth.
MaxNestedMessageDepth Int32 optionalposition: namedpipeline: False
Maximum embedded-message recursion depth.
MaxPartCount Int32 optionalposition: namedpipeline: False
Maximum MIME entity count.
MaxTnefAttributeCount Int32 optionalposition: namedpipeline: False
Maximum number of TNEF attributes.
MaxTotalAttachmentBytes Int64 optionalposition: namedpipeline: False
Maximum aggregate decoded attachment bytes.
PreserveRawSource SwitchParameter optionalposition: namedpipeline: False
Retain original artifact bytes for an explicit lossless write.

Outputs

OfficeIMO.Email.EmailReaderOptions