Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

View on GitHub Releases Get package
Stars 654
Forks 82
Open issues 1
Total downloads 4,320,051
Release OfficeIMO-v3.5.3
Language: C# Updated: 2026-11-03
Cmdlet

Save-OfficeEmailMailbox

Module
PSWriteOffice
Inputs
OfficeIMO.Email.EmailMailbox
Outputs
OfficeIMO.Email.EmailWriteResult
Source
SaveOfficeEmailMailboxCommand.cs:16 Edit on GitHub

Saves a native mbox mailbox with output diagnostics.

Syntax

Save-OfficeEmailMailbox
-Mailbox <EmailMailbox>
[-Options <EmailMailboxWriterOptions>]
[-PassThru]
[-Path] <String>
[<CommonParameters>]
#
Parameter set: All Parameter Sets

Examples

Save an mboxrd mailbox and return its diagnostics.

$options = New-OfficeEmailMailboxWriterOptions -Variant Mboxrd
$mailbox | Save-OfficeEmailMailbox -Path .\Archive.mbox -Options $options -PassThru

Parameters

-Mailbox EmailMailbox requiredpipeline: True (ByValue)
Mailbox to save.
-Options EmailMailboxWriterOptions optional
Optional mailbox variant, envelope, and output limits.
-PassThru SwitchParameter optional
Emit the object created or changed by the command.
-Path String requiredposition: 0
Destination mbox 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.