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

Get-OfficeEmailMailbox

Module
PSWriteOffice
Inputs
System.String
Outputs
OfficeIMO.Email.EmailMailbox OfficeIMO.Email.EmailMailboxReadResult
Source
GetOfficeEmailMailboxCommand.cs:15 Edit on GitHub

Reads a native mbox mailbox with bounded per-message diagnostics.

Syntax

Get-OfficeEmailMailbox
[-AsResult]
[-Options <EmailMailboxReaderOptions>]
[-Path] <String>
[<CommonParameters>]
#
Parameter set: All Parameter Sets

Examples

Read a bounded mbox mailbox with diagnostics.

$options = New-OfficeEmailMailboxReaderOptions -MaxMessageCount 5000
Get-OfficeEmailMailbox -Path .\Archive.mbox -Options $options -AsResult

Parameters

-AsResult SwitchParameter optional
Return the mailbox read result with diagnostics.
-Options EmailMailboxReaderOptions optional
Optional mailbox variant and input limits.
-Path String requiredposition: 0pipeline: True (ByValue)
Path to an mbox or mbx file.

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.