Skip to main content

Invoke-ModernMailboxPermReport

SYNOPSIS

Generates a user-centric mailbox permission report.

SYNTAX

Invoke-ModernMailboxPermReport [[-OutPath] <String>] [[-PermissionType] <String[]>] [-IncludeInherited] [-Raw]
[-AddHtmlOutput] [-DisableTelemetry] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Reads mailbox permissions (Full Access, Send As, Send on Behalf) from Exchange Online and pivots them so you can see which user has access to which mailboxes. Supports optional export to CSV or JSON.

EXAMPLES

EXAMPLE 1

Invoke-ModernMailboxPermReport

EXAMPLE 2

Invoke-ModernMailboxPermReport -OutPath C:\Reports\MailboxPermissionReport.html

EXAMPLE 3

Invoke-ModernMailboxPermReport -OutPath C:\Reports

EXAMPLE 4

Invoke-ModernMailboxPermReport -AddHtmlOutput -OutPath C:\Reports

EXAMPLE 5

Invoke-ModernMailboxPermReport -PermissionType FullAccess,SendAs -OutPath C:\Reports\perm.json

EXAMPLE 6

Invoke-ModernMailboxPermReport -PermissionType FullAccess,SendAs -Raw -OutPath C:\Reports\perm.json

PARAMETERS

-OutPath

Optional path for exporting the report. Provide a folder to create MailboxPermissionReport.csv or a specific file path ending in .csv or .json.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PermissionType

Filters which permission types to include. Defaults to all.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: @('FullAccess', 'SendAs', 'SendOnBehalf')
Accept pipeline input: False
Accept wildcard characters: False

-IncludeInherited

Include inherited Full Access entries (Default permissions). Off by default.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Raw

Return one row per permission assignment instead of the per-user summary.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AddHtmlOutput

Emit an HTML report (MailboxPermissionReport.html)

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-DisableTelemetry

Disable telemetry

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

Fill ProgressAction Description

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

https://exchangepermissions.alweys.ch/modernmailtools/Invoke-ModernMailboxPermReport