Get-onPremFullMailboxAccess.ps1

<#
    .SYNOPSIS

    This function locates any mailbox level permissions on the DL to be migrated.

    .DESCRIPTION

    This function locates any mailbox level permissions on the DL to be migrated.

    .PARAMETER originalDLConfiguration

    The mail attribute of the group to search.

    .PARAMETER collectedData

    The precollected data to search for full mailbox access permissions.

    .OUTPUTS

    Returns a list of all mailboxes where the migrated DL has full mailbox accesses.

    .EXAMPLE

    Get-onPremFullMailboxAccess -originalDLConfiguration DLConfig -collectedData Data

    #>
    Function Get-onPremFullMailboxAccess
    {
        [cmdletbinding()]

        Param
        (
            [Parameter(Mandatory = $true)]
            $originalDLConfiguration,
            [Parameter(Mandatory = $false)]
            $collectedData=$NULL
        )

        #Output all parameters bound or unbound and their associated values.

        write-functionParameters -keyArray $MyInvocation.MyCommand.Parameters.Keys -parameterArray $PSBoundParameters -variableArray (Get-Variable -Scope Local -ErrorAction Ignore)

        #Declare function variables.

        [array]$functionPermissions=@()
        $functionRecipients=@()

        Out-LogFile -string "********************************************************************************"
        Out-LogFile -string "BEGIN Get-onPremFullMailboxAccess"
        Out-LogFile -string "********************************************************************************"

        if ($collectedData -eq $NULL)
        {
            #Start function processing.

            try {
                out-logfile -string "Gathering all on premises mailboxes."

                $functionRecipients = invoke-command {get-mailbox -resultsize unlimited}
            }
            catch {
                out-logfile -string "Error attempting to invoke command to gather all recipients."
                out-logfile -string $_ -isError:$TRUE
            }

            #We now have all the mailbox recipients.

            try {
                out-logfile -string "Test for mailbox permissions."

                $ProgressDelta = 100/($functionRecipients.count); $PercentComplete = 0; $MbxNumber = 0

                foreach ($recipient in $functionRecipients)
                {
                    $MbxNumber++

                    write-progress -activity "Processing Recipient" -status $recipient.primarySMTPAddress -PercentComplete $PercentComplete

                    $PercentComplete += $ProgressDelta

                    if ($functionCounter -gt 1000)
                    {
                        #Implement function counter for long running operations - pause for 5 seconds every 1000 queries.

                        start-sleepProgress -sleepString "Throttling for 5 seconds at 1000 operations." -sleepSeconds 5

                        $functionCounter=0
                    }
                    else 
                    {
                        $functionCounter++    
                    }

                    $functionPermissions+= invoke-command {Get-MailboxPermission -identity $args[0] -user $args[1]}-ArgumentList $recipient.identity,$originalDLConfiguration.samAccountName
                } 
            }
            catch {
                out-logfile -string "Error attempting to invoke command to gather all mailbox permissions."
                out-logfile -string $_ -isError:$TRUE
            }

            write-progress -activity "Processing Recipient" -completed
        }
        elseif ($collectedData -ne $NULL)
        {
            out-logfile -string "Testing for full mailbox access rights.."

            $functionPermissions = $collectedData | where {($_.user.tolower()).contains($originalDLConfiguration.samAccountName.toLower())}
        }

        Out-LogFile -string "********************************************************************************"
        Out-LogFile -string "END Get-onPremFullMailboxAccess"
        Out-LogFile -string "********************************************************************************" 

        
        if ($functionPermissions.count -gt 0)
        {
            out-logfile -string $functionPermissions
            return $functionPermissions
        }
    }