Save-OfficeEmailMailbox

Namespace PSWriteOffice

Inputs

OfficeIMO.Email.EmailMailbox

Outputs

OfficeIMO.Email.EmailWriteResult

Source

Sources/PSWriteOffice/Cmdlets/Email/SaveOfficeEmailMailboxCommand.cs:16 Edit on GitHub

Saves a native mbox mailbox with output diagnostics.

Remarks

Saves a native mbox mailbox with output diagnostics.

Examples

Authored help example

Save an mboxrd mailbox and return its diagnostics.

PS>


$options = New-OfficeEmailMailboxWriterOptions -Variant Mboxrd
            $mailbox | Save-OfficeEmailMailbox -Path .\Archive.mbox -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

Save-OfficeEmailMailbox -Mailbox <EmailMailbox> [-Options <EmailMailboxWriterOptions>] [-PassThru] -Path <String> [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Mailbox EmailMailbox requiredposition: namedpipeline: True (ByValue): Mailbox to save.
Options EmailMailboxWriterOptions optionalposition: namedpipeline: False: Optional mailbox variant, envelope, and output limits.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the object created or changed by the command.
Path String requiredposition: 0pipeline: False: Destination mbox path.

Outputs

OfficeIMO.Email.EmailWriteResult