New-OfficeEmailMailboxReaderOptions

Namespace PSWriteOffice

Inputs

OfficeIMO.Email.EmailReaderOptions

Outputs

OfficeIMO.Email.EmailMailboxReaderOptions

Source

Sources/PSWriteOffice/Cmdlets/Email/NewOfficeEmailMailboxReaderOptionsCommand.cs:16 Edit on GitHub

Creates bounded mbox reader settings through ordinary PowerShell parameters.

Remarks

Creates bounded mbox reader settings through ordinary PowerShell parameters.

Examples

Authored help example

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

PS>


$messageOptions = New-OfficeEmailReaderOptions -ExcludeAttachmentContent
            $options = New-OfficeEmailMailboxReaderOptions -MessageOptions $messageOptions -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

New-OfficeEmailMailboxReaderOptions [-MaxMailboxBytes <Int64>] [-MaxMessageCount <Int32>] [-MessageOptions <EmailReaderOptions>] [-Variant <Auto|Mboxo|Mboxrd>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

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

Outputs

OfficeIMO.Email.EmailMailboxReaderOptions