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

New-OfficeEmailMailboxReaderOptions

Module
PSWriteOffice
Inputs
OfficeIMO.Email.EmailReaderOptions
Outputs
OfficeIMO.Email.EmailMailboxReaderOptions
Source
NewOfficeEmailMailboxReaderOptionsCommand.cs:16 Edit on GitHub

Creates bounded mbox reader settings through ordinary PowerShell parameters.

Syntax

New-OfficeEmailMailboxReaderOptions
[-MaxMailboxBytes <Int64>]
[-MaxMessageCount <Int32>]
[-MessageOptions <EmailReaderOptions>]
[-Variant <Auto|Mboxo|Mboxrd>]
[<CommonParameters>]
#
Parameter set: All Parameter Sets

Examples

Read a bounded mailbox with a reusable per-message policy.

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

Parameters

-MaxMailboxBytes Int64 optional
Maximum aggregate source bytes consumed from one mailbox.
-MaxMessageCount Int32 optional
Maximum messages in one mailbox.
-MessageOptions EmailReaderOptions optionalpipeline: True (ByValue)
Bounded policy applied independently to each message.
-Variant MboxVariant optional
Escaping convention to decode.
Possible values: Auto, Mboxo, Mboxrd

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.