Cmdlet

Save-OfficeEmail

Module PSWriteOffice

Inputs

OfficeIMO.Email.EmailDocument

Outputs

OfficeIMO.Email.EmailWriteResult

Source

SaveOfficeEmailCommand.cs:17 Edit on GitHub

Saves an email document as EML, EMLX, MSG, or TNEF with fidelity diagnostics.

Syntax

Save-OfficeEmail -Document <EmailDocument> [-Format <EmailFileFormat>] [-Options <EmailWriterOptions>] [-PassThru] [-Path] <String> [<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Authored help example

Save a message with an explicit loss policy.

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

Parameters

-Document EmailDocument requiredpipeline: True (ByValue): Email document to save.
-Format EmailFileFormat optional: Optional explicit output format. By default it is inferred from the filename.; Possible values: Unknown, Eml, OutlookMsg, Tnef, Mbox, OutlookTemplate, Emlx
-Options EmailWriterOptions optional: Optional preservation, projection, encoding, and output limits.
-PassThru SwitchParameter optional: Emit the object created or changed by the command.
-Path String requiredposition: 0: Destination path.

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.