M365.Report.Tools

1.0

Functions/Get-M365MailboxReport.ps1

function Get-M365MailboxReport
{
    [CmdletBinding(SupportsPaging=$true)]
    param (
        [Switch]$SharedOnly,
        [Switch]$ResourceOnly,
        [Switch]$UserOnly,
        [Switch]$All = $true,
        [Switch]$IncludeMailboxSize,
        [String[]]$AddProperties
    )
    try {
    if ($SharedOnly){
        $All = $false
        $Mailboxes = Get-Mailbox -Filter { isShared -eq 'true' } -Resultsize Unlimited
    }
    if ($ResourceOnly){
        $All = $false
        $Mailboxes = Get-Mailbox -Filter { isResource -eq 'true' } -Resultsize Unlimited
    }
    if ($UserOnly){
        $All = $false
        $Mailboxes = Get-Mailbox -Filter { (isShared -eq 'false') -and (isResource -eq 'false') } -Resultsize Unlimited
    }
    if ($All){
        $Mailboxes = Get-Mailbox -Resultsize Unlimited
    }
}
catch [System.Management.Automation.CommandNotFoundException]{
    Throw "You must first call Connect-ExchangeOnline before running this command"    
}
    $MailboxProperties = ($Mailboxes | Get-Member -MemberType Property).Name    
    $i = 1
    $MailboxDetails = [System.Collections.Generic.List[PsObject]]::new()
    foreach ($box in $Mailboxes)
    {
        Switch ($box.RecipientTypeDetails){
            UserMailbox {$type = 'UserMailbox'}
            RoomMailbox {$type = 'RoomMailbox'}
            SchedulingMailbox {$type = 'SchedulingMailbox'}
            DiscoveryMailbox {$type = 'DiscoveryMailbox'}
            SharedMailbox {$type = 'SharedMailbox'}
        }
        Write-Progress -Activity "Processing Mailbox Report" -Status "Working on $($box.displayname)" -PercentComplete (($i / $mailboxes.Count) * 100)        
        $SingleMailboxDetails = $box | Select-Object Identity, Displayname, PrimarySMTPAddress, @{
            n = 'EmailAddresses'; e = { ($_.EmailAddresses -join ' , ') }},HiddenFromAddressListsEnabled,@{
                n = 'GrantSendOnBehalfTo'; e = { ($_.GrantSendOnBehalfTo -join ' , ') }},@{ 
                        n = 'Type' ; e={$type}}, ForwardingAddress, ForwardingSmtpAddress , IsInactiveMailbox
        foreach ($NewProp in $AddProperties){ 
            # Check if given additional propety is valid
            if ($NewProp -notin $MailboxProperties){Write-Error "$NewProp is not a valid mailbox property`nValid Properties incude:`n$($MailboxProperties)"
            break
        }           
            Write-Progress -Activity "Adding Additional Properties" -Status "Working on $NewProp for mailbox $($box.displayname)"
            $SingleMailboxDetails | Add-Member -MemberType NoteProperty -Name $NewProp -Value ($box | Select-Object -ExpandProperty $NewProp)
        }
        $MailboxDetails.Add($SingleMailboxDetails)       
        $i++
    }
    $i = 1
    if ($IncludeMailboxSize){
        foreach ($box in $MailboxDetails){
            Write-Progress -Activity "Processing Mailbox Permissions" -Status "Working on $($box.displayname)" -PercentComplete (($i / $mailboxes.Count) * 100) 
            $TotalSize = (Get-MailboxStatistics -Identity $box.identity).TotalItemSize
            $box | Add-Member -MemberType NoteProperty -Name 'TotalSize' -Value $TotalSize
        $i++
        }
    }    
    $MailboxDetails
    Write-Warning "Please remember to disconnect from the Exchange Online by using 'Disconnect-ExchangeOnline'"
}