New-OfficeEmailWriterOptions

Namespace PSWriteOffice

Inputs

None

Outputs

OfficeIMO.Email.EmailWriterOptions

Source

Sources/PSWriteOffice/Cmdlets/Email/NewOfficeEmailWriterOptionsCommand.cs:15 Edit on GitHub

Creates deterministic email writer settings through ordinary PowerShell parameters.

Remarks

Creates deterministic email writer settings through ordinary PowerShell parameters.

Examples

Authored help example

Preserve the original source when possible and block semantic loss.

PS>


$options = New-OfficeEmailWriterOptions -UsePreservedRawSource -ConversionLossPolicy Block
            $message | Save-OfficeEmail -Path .\Message.eml -Options $options -PassThru

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-OfficeEmailWriterOptions [-Base64LineLength <Int32>] [-ConversionLossPolicy <Block|Warn|Allow>] [-IncludeBccHeader] [-MaxNestedMessageDepth <Int32>] [-MaxOutputBytes <Int64>] [-UsePreservedRawSource] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Base64LineLength Int32 optionalposition: namedpipeline: False: Maximum encoded characters on one Base64 body line.
ConversionLossPolicy EmailConversionLossPolicy optionalposition: namedpipeline: Falsevalues: 3: Policy applied when the requested format cannot preserve known message semantics.; Possible values: Block, Warn, Allow
IncludeBccHeader SwitchParameter optionalposition: namedpipeline: False: Write Bcc recipients into the message header.
MaxNestedMessageDepth Int32 optionalposition: namedpipeline: False: Maximum embedded-message write depth.
MaxOutputBytes Int64 optionalposition: namedpipeline: False: Maximum serialized artifact size.
UsePreservedRawSource SwitchParameter optionalposition: namedpipeline: False: Emit an unchanged preserved source instead of regenerating the artifact when possible.

Outputs

OfficeIMO.Email.EmailWriterOptions