Cmdlet

Open-OfficeEmailMailbox

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

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

Syntax

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

Parameter set: Path

Open-OfficeEmailMailbox
[-AsResult]
-LiteralPath <String>
[-Options <EmailMailboxReaderOptions>]
[<CommonParameters>]

Parameter set: LiteralPath

Examples

Read a bounded mbox mailbox with diagnostics.

$options = New-OfficeEmailMailboxReaderOptions -MaxMessageCount 5000
Open-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)sets: Path: Path to an mbox or mbx file.
-LiteralPath String requiredpipeline: True (ByPropertyName)aliases: FullName, PSPathsets: LiteralPath: Exact input path without wildcard expansion.

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.