Get-OfficeEmailMailbox

Namespace PSWriteOffice

Inputs

System.String

Outputs

OfficeIMO.Email.EmailMailbox OfficeIMO.Email.EmailMailboxReadResult

Source

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

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

Remarks

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

Examples

Authored help example

Read a bounded mbox mailbox with diagnostics.

PS>


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

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

Get-OfficeEmailMailbox [-AsResult] [-Options <EmailMailboxReaderOptions>] -Path <String> [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

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

Outputs

OfficeIMO.Email.EmailMailbox, OfficeIMO.Email.EmailMailboxReadResult