├── .github └── workflows │ └── ci.yml ├── .vscode ├── extensions.json └── settings.json ├── Find-EAPEnabledMailbox.ps1 ├── Get-DomainMailboxReport.ps1 ├── Get-GroupsReport.ps1 ├── Get-InactiveMailboxes.ps1 ├── Get-MailTrafficReport.ps1 ├── Get-MailboxLocation.ps1 ├── Get-MailboxReport.ps1 ├── Get-MailboxStatsReport.ps1 ├── Initializer.ps1 ├── LICENSE ├── PSScriptAnalyzerSettings.psd1 ├── README.md ├── Remove-SpecificAlias.ps1 ├── Resolve-PendingMigrations.ps1 ├── Set-MailboxQuota.ps1 └── Utilities.ps1 /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: ci 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | branches: 9 | - main 10 | 11 | jobs: 12 | lint: 13 | name: Run PSScriptAnalyzer 14 | runs-on: ubuntu-latest 15 | steps: 16 | - name: Checkout 🛎 17 | uses: actions/checkout@v2 18 | 19 | - name: Lint 🕵🏻‍♂️ 20 | uses: devblackops/github-action-psscriptanalyzer@master 21 | with: 22 | repoToken: ${{ secrets.GITHUB_TOKEN }} 23 | -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": [ 3 | "ms-vscode.powershell" 4 | ] 5 | } -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "powershell.scriptAnalysis.enable": true, 3 | } 4 | -------------------------------------------------------------------------------- /Find-EAPEnabledMailbox.ps1: -------------------------------------------------------------------------------- 1 | param ( 2 | [Alias('DEAP')][Switch]$DisableEAP, 3 | [Alias('OUT')][Switch]$Output 4 | ) 5 | 6 | begin { 7 | . "$PSScriptRoot\Initializer.ps1" 8 | $params = Invoke-Expression "Initialize-DefaultParam $args" 9 | } 10 | 11 | process { 12 | $recipients = ( 13 | Get-Recipient -ResultSize Unlimited | 14 | Where-Object { 15 | $_.RecipientTypeDetails -like '*Mailbox' -and 16 | $_.EmailAddressPolicyEnabled -eq $true 17 | } | 18 | Select-Object -ExpandProperty SamAccountName 19 | ) 20 | 21 | if ($null -eq $recipients) { 22 | $recipients = @() 23 | } 24 | 25 | if ($Output) { 26 | $recipients | 27 | Select-Object SamAccountName, PrimarySmtpAddress, Company | 28 | Export-Csv $params.outputFilePath -NoTypeInformation 29 | } 30 | 31 | if ($DisableEAP) { 32 | $recipientsCount = $recipients.Count 33 | 34 | Write-Output "To process $recipientsCount recipients" 35 | 36 | for ($index = 0; $index -lt $recipientsCount; $index++) { 37 | $recipient = $recipients[$index] 38 | 39 | Write-Output "Processing recipient $($index + 1) / $recipientsCount | $recipient" 40 | 41 | $location = Get-ExchangeObjectLocation -ExchangeObject $recipient 42 | 43 | switch ($location) { 44 | ([ExchangeObjectLocation]::notAvailable) { 45 | Write-Output "`tMailbox does not exist anymore. Skipping mailbox..." 46 | 47 | break 48 | } 49 | ([ExchangeObjectLocation]::exchangeOnPremises) { 50 | Set-Mailbox $recipient -EmailAddressPolicyEnabled $false 51 | 52 | break 53 | } 54 | ([ExchangeObjectLocation]::exchangeOnline) { 55 | Set-RemoteMailbox $recipient -EmailAddressPolicyEnabled $false 56 | 57 | break 58 | } 59 | } 60 | } 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /Get-DomainMailboxReport.ps1: -------------------------------------------------------------------------------- 1 | begin { 2 | . "$PSScriptRoot\Initializer.ps1" 3 | $params = Invoke-Expression "Initialize-DefaultParam $args" 4 | } 5 | 6 | process { 7 | Start-Transcript "$($params.outputFilePath).txt" 8 | 9 | Write-Output 'To gather all recipient information' 10 | $allRecipients = Get-Recipient -ResultSize Unlimited | 11 | Where-Object { $_.RecipientType -match 'User' } 12 | 13 | $domains = Get-AcceptedDomain 14 | $domainsCount = $domains | Measure-Object | 15 | Select-Object -ExpandProperty Count 16 | Write-Output "To process $domainsCount domains" 17 | 18 | for ($index = 0; $index -lt $domainsCount; $index++) { 19 | $domain = $domains[$index] 20 | Write-Output ( 21 | "Processing domain $($index + 1) / $domainsCount | $domain" 22 | ) 23 | $matchMailboxes = $null 24 | $matchMailboxes = $allRecipients | 25 | Where-Object { $_.EmailAddresses -match $domain } 26 | $matchMailboxesAlias = $matchMailboxes | 27 | Where-Object { $_.PrimarySmtpAddress -notmatch $domain -and 28 | $_.EmailAddresses -match $domain } 29 | $matchMailboxesAliasCount = $matchMailboxesAlias | 30 | Measure-Object | Select-Object -ExpandProperty Count 31 | $matchMailboxesCount = $matchMailboxes | Measure-Object | 32 | Select-Object -ExpandProperty Count 33 | $matchMailboxesEXP = 0 34 | $matchMailboxesEXO = 0 35 | Write-Output "To process $matchMailboxesCount exchange objects" 36 | for ($jindex = 0; $jindex -lt $matchMailboxesCount; $jindex++) { 37 | $matchMailbox = $matchMailboxes[$jindex] 38 | Write-Output ( 39 | "Processing domain $($index + 1) / $domainsCount | $domain |", 40 | "Processing exchange object $($jindex + 1) / $matchMailboxesCount | $matchMailbox" 41 | ) 42 | $location = Get-ExchangeObjectLocation -ExchangeObject $matchMailbox 43 | if ($location -eq 'exchangeOnPremises') { 44 | $matchMailboxesEXP++ 45 | } elseif ($location -eq 'exchangeOnline') { 46 | $matchMailboxesEXO++ 47 | } 48 | } 49 | 50 | [PSCustomObject]@{ 51 | Domain = $domain 52 | MailboxesCount = $matchMailboxesCount 53 | EXPMailboxes = $matchMailboxesEXP 54 | EXOMailboxes = $matchMailboxesEXO 55 | Aliases = $matchMailboxesAliasCount 56 | } | Export-Csv $params.outputFilePath -Append -NoTypeInformation 57 | } 58 | 59 | Stop-Transcript 60 | } 61 | 62 | end { 63 | Send-DefaultReportMail -ScriptParams $params 64 | } -------------------------------------------------------------------------------- /Get-GroupsReport.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | .SYNOPSIS 3 | This report computes the companies groups belong to based on its managers' and members' companies. 4 | 5 | .DESCRIPTION 6 | This report has a mandatory parameter named -Type. 7 | Value must be 'Distribution Groups' or 'Microsoft 365 Groups'. 8 | 9 | .PARAMETER Type 10 | Specifies the type of groups this report will process and output. 11 | You may use 'Distribution Groups' or 'Microsoft 365 Groups'. 12 | 13 | .PARAMETER CompanyIdentifierAttribute 14 | Defines the attribute where your organization stores the value for a user's company in Exchange. 15 | This can be 'Company' but may as well be 'CustomAttribute4' or even 'Notes'. 16 | 17 | .PARAMETER FirstCompanyName 18 | Only used for output. 19 | 20 | .PARAMETER SecondCompanyName 21 | Only used for output. 22 | 23 | .PARAMETER FirstCompanyIdentifier 24 | Shows how your organization defines a user's company. 25 | For example, user A might be part of 'Contoso' company but, in Exchange, 26 | 'Contoso' might be defined by the value 'CompanyA' of the attribute 'CustomAttribute1'. 27 | 28 | .PARAMETER SecondCompanyIdentifier 29 | Shows how your organization defines a user's company. 30 | For example, user A might be part of 'Contoso' company but, in Exchange, 31 | 'Contoso' might be defined by the value 'CompanyA' of the attribute 'CustomAttribute1'. 32 | 33 | .EXAMPLE 34 | PS> .\Get-GroupsReport.ps1 ` 35 | -Type 'Distribution Groups' ` 36 | -CIA 'CustomAttribute1' ` 37 | -FCN 'contoso' ` 38 | -FCI 'CompanyA' ` 39 | -SCN 'fabrikam' ` 40 | -SCI 'CompanyB' 41 | #> 42 | 43 | using namespace System.Management.Automation 44 | 45 | param ( 46 | [Parameter(Mandatory)] 47 | [ValidateSet('Distribution Groups', 'Microsoft 365 Groups')] 48 | [String] 49 | $Type, 50 | 51 | [Alias('FCI')] 52 | [String] 53 | $FirstCompanyIdentifier, 54 | 55 | [Alias('FCN')] 56 | [String] 57 | $FirstCompanyName, 58 | 59 | [Alias('SCI')] 60 | [String] 61 | $SecondCompanyIdentifier, 62 | 63 | [Alias('SCN')] 64 | [String] 65 | $SecondCompanyName, 66 | 67 | [Alias('CIA')] 68 | [String] 69 | $CompanyIdentifierAttribute 70 | ) 71 | 72 | begin { 73 | enum GroupsType { 74 | none 75 | distribution 76 | unified 77 | } 78 | 79 | . "$PSScriptRoot\Initializer.ps1" 80 | $params = Invoke-Expression "Initialize-DefaultParam $args" 81 | 82 | $typeParams = @{ 83 | Name = 'Type' 84 | Value = $Type 85 | Config = $params.config 86 | ScriptName = $params.scriptName 87 | } 88 | $Type = Read-Param @typeParams 89 | 90 | $firstCompanyIdentifierParams = @{ 91 | Name = 'FirstCompanyIdentifier' 92 | Value = $FirstCompanyIdentifier 93 | Config = $params.config 94 | ScriptName = $params.scriptName 95 | } 96 | $FirstCompanyIdentifier = Read-Param @firstCompanyIdentifierParams 97 | 98 | $firstCompanyNameParams = @{ 99 | Name = 'FirstCompanyName' 100 | Value = $FirstCompanyName 101 | Config = $params.config 102 | ScriptName = $params.scriptName 103 | } 104 | $FirstCompanyName = Read-Param @firstCompanyNameParams 105 | 106 | $secondCompanyIdentifierParams = @{ 107 | Name = 'SecondCompanyIdentifier' 108 | Value = $SecondCompanyIdentifier 109 | Config = $params.config 110 | ScriptName = $params.scriptName 111 | } 112 | $SecondCompanyIdentifier = Read-Param @secondCompanyIdentifierParams 113 | 114 | $secondCompanyNameParams = @{ 115 | Name = 'SecondCompanyName' 116 | Value = $SecondCompanyName 117 | Config = $params.config 118 | ScriptName = $params.scriptName 119 | } 120 | $SecondCompanyName = Read-Param @secondCompanyNameParams 121 | 122 | $companyIdentifierAttributeParams = @{ 123 | Name = 'CompanyIdentifierAttribute' 124 | Value = $CompanyIdentifierAttribute 125 | Config = $params.config 126 | ScriptName = $params.scriptName 127 | } 128 | $CompanyIdentifierAttribute = Read-Param @companyIdentifierAttributeParams 129 | 130 | switch ($Type) { 131 | 'Distribution Groups' { $groupsType = [GroupsType]::distribution } 132 | 'Microsoft 365 Groups' { $groupsType = [GroupsType]::unified } 133 | Default { $groupsType = [GroupsType]::none } 134 | } 135 | 136 | function Get-ManagersFromList { 137 | param ( 138 | [Object[]]$List 139 | ) 140 | 141 | $managers = $List | 142 | Get-Recipient -ResultSize Unlimited -ErrorAction SilentlyContinue | 143 | Select-Object $CompanyIdentifierAttribute, PrimarySmtpAddress, Company 144 | 145 | return $managers 146 | } 147 | 148 | function Get-MembersListFromGroup { 149 | param ( 150 | [PSObject]$Group 151 | ) 152 | 153 | switch ($groupsType) { 154 | ([GroupsType]::distribution) { 155 | $getADGroupMemberParams = @{ 156 | Identity = $Group.SamAccountName 157 | Recursive = $true 158 | ErrorAction = [ActionPreference]::SilentlyContinue 159 | } 160 | $list = Get-ADGroupMember @getADGroupMemberParams | 161 | Get-ADUser -Properties mail | 162 | Where-Object { $_.Enabled -eq 'True' -and $_.mail } | 163 | Select-Object -ExpandProperty mail 164 | } 165 | ([GroupsType]::unified) { 166 | $getGroupParams = @{ 167 | Identity = $Group.SamAccountName 168 | ErrorAction = [ActionPreference]::SilentlyContinue 169 | } 170 | $list = Get-Group @getGroupParams | 171 | Select-Object -ExpandProperty Members 172 | } 173 | } 174 | 175 | return $list 176 | } 177 | 178 | function Get-MembersFromList { 179 | param ( 180 | [Object[]]$List 181 | ) 182 | 183 | $members = $List | 184 | Get-Recipient -ResultSize Unlimited -ErrorAction SilentlyContinue | 185 | Select-Object $CompanyIdentifierAttribute, PrimarySmtpAddress 186 | 187 | return $members 188 | } 189 | 190 | function Get-MembersFromGroup { 191 | param ( 192 | [PSObject]$Group 193 | ) 194 | 195 | $list = Get-MembersListFromGroup $Group 196 | 197 | if (-not $list) { 198 | return $null 199 | } 200 | 201 | $members = Get-MembersFromList $list 202 | 203 | if (-not $members) { 204 | return $null 205 | } 206 | 207 | return $members 208 | } 209 | } 210 | 211 | process { 212 | # Workaround for https://github.com/PowerShell/PSScriptAnalyzer/issues/1643. 213 | Write-Verbose $FirstCompanyIdentifier 214 | Write-Verbose $SecondCompanyIdentifier 215 | 216 | if ($groupsType -eq [GroupsType]::none) { 217 | Write-Error "Filtering by the groups type '$Type' is not implemented!" 218 | 219 | return 220 | } 221 | 222 | Start-Transcript "$($params.outputFilePath).txt" 223 | 224 | switch ($groupsType) { 225 | ([GroupsType]::distribution) { 226 | $groups = Get-DistributionGroup -ResultSize Unlimited | 227 | Select-Object WindowsEmailAddress, ManagedBy, Name, RecipientType, Guid, 228 | SamAccountName 229 | } 230 | ([GroupsType]::unified) { 231 | $groups = Get-Group -ResultSize Unlimited -Filter { 232 | RecipientTypeDetails -eq 'GroupMailbox' 233 | } | 234 | Select-Object WindowsEmailAddress, ManagedBy, Name, RecipientType, Guid, 235 | SamAccountName 236 | } 237 | } 238 | 239 | $groupsCount = @($groups).Count 240 | 241 | Write-Output "To process: $groupsCount groups" 242 | 243 | for ($index = 0; $index -lt $groupsCount; $index++) { 244 | Write-Output "`tProcessing group: $($index + 1) / $groupsCount" 245 | 246 | Start-Sleep -Milliseconds 500 247 | 248 | $group = $groups[$index] 249 | 250 | $groupManagersList = $group.ManagedBy 251 | 252 | $areManagersInBothCompanies = $false 253 | $areMembersInBothCompanies = $false 254 | 255 | $groupManagers = $null 256 | $groupMembers = $null 257 | 258 | $groupManagerProperties = $null 259 | $groupMemberProperties = $null 260 | 261 | $groupManagersCount = 0 262 | $groupMembersCount = 0 263 | 264 | $firstCompanyManagersCount = 0 265 | $firstCompanyMembersCount = 0 266 | 267 | $secondCompanyManagersCount = 0 268 | $secondCompanyMembersCount = 0 269 | 270 | if ($groupManagersList) { 271 | $groupManagers = Get-ManagersFromList $groupManagersList 272 | 273 | $groupManagersCount = ($groupManagers | Measure-Object).Count 274 | $groupManagerProperties = $groupManagers.$CompanyIdentifierAttribute 275 | 276 | $firstCompanyManagersCount = ( 277 | $groupManagerProperties | 278 | Where-Object { $_ -like $FirstCompanyIdentifier } | 279 | Measure-Object 280 | ).Count 281 | $secondCompanyManagersCount = ( 282 | $groupManagerProperties | 283 | Where-Object { $_ -like $SecondCompanyIdentifier } | 284 | Measure-Object 285 | ).Count 286 | 287 | $areManagersInBothCompanies = ( 288 | $firstCompanyManagersCount -and $secondCompanyManagersCount 289 | ) 290 | 291 | $groupUsersCount = $groupManagersCount 292 | 293 | $firstCompanyUsersCount = $firstCompanyManagersCount 294 | $secondCompanyUsersCount = $secondCompanyManagersCount 295 | } else { 296 | $groupMembers = Get-MembersFromGroup $group 297 | 298 | if ($groupMembers) { 299 | $groupMembersCount = ($groupMembers | Measure-Object).Count 300 | $groupMemberProperties = $groupMembers.$CompanyIdentifierAttribute 301 | 302 | $firstCompanyMembersCount = ( 303 | $groupMemberProperties | 304 | Where-Object { $_ -like $FirstCompanyIdentifier } | 305 | Measure-Object 306 | ).Count 307 | $secondCompanyMembersCount = ( 308 | $groupMemberProperties | 309 | Where-Object { $_ -like $SecondCompanyIdentifier } | 310 | Measure-Object 311 | ).Count 312 | 313 | $areMembersInBothCompanies = ( 314 | $firstCompanyMembersCount -and $secondCompanyMembersCount 315 | ) 316 | 317 | $groupUsersCount = $groupMembersCount 318 | 319 | $firstCompanyUsersCount = $firstCompanyMembersCount 320 | $secondCompanyUsersCount = $secondCompanyMembersCount 321 | } else { 322 | $groupUsersCount = 0 323 | 324 | $firstCompanyUsersCount = 0 325 | $secondCompanyUsersCount = 0 326 | } 327 | } 328 | 329 | if ($groupManagersList) { 330 | if (-not $groupManagers) { 331 | $groupManagers = Get-ManagersFromList $groupManagersList 332 | } 333 | 334 | $groupManagersSMTPAddresses = ( 335 | $groupManagers | Select-Object -ExpandProperty PrimarySmtpAddress 336 | ) -join ';' 337 | $groupManagersCompanies = ( 338 | $groupManagers | Select-Object -ExpandProperty Company 339 | ) -join ';' 340 | } else { 341 | $groupManagersSMTPAddresses = '' 342 | $groupManagersCompanies = '' 343 | } 344 | 345 | $hasFirstCompanyUsers = $firstCompanyUsersCount -gt 0 346 | $hasSecondCompanyUsers = $secondCompanyUsersCount -gt 0 347 | $hasFirstOrSecondCompanyUsers = $hasFirstCompanyUsers -or $hasSecondCompanyUsers 348 | 349 | $hasOnlyFirstCompanyUsers = $hasFirstCompanyUsers -and (-not $hasSecondCompanyUsers) 350 | $hasOnlySecondCompanyUsers = (-not $hasFirstCompanyUsers) -and $hasSecondCompanyUsers 351 | 352 | if (-not $hasFirstOrSecondCompanyUsers) { 353 | $groupCompany = 'None' 354 | } elseif ($areManagersInBothCompanies) { 355 | $groupCompany = 'Mixed Owners' 356 | } elseif ($areMembersInBothCompanies) { 357 | $groupCompany = 'Mixed Users' 358 | } elseif ($groupUsersCount -eq $firstCompanyUsersCount -or $hasOnlyFirstCompanyUsers) { 359 | $groupCompany = $FirstCompanyName 360 | } elseif ($groupUsersCount -eq $secondCompanyUsersCount -or $hasOnlySecondCompanyUsers) { 361 | $groupCompany = $SecondCompanyName 362 | } else { 363 | $groupCompany = 'N/A' 364 | } 365 | 366 | if ($groupCompany -eq $FirstCompanyName -or $groupCompany -like 'Mixed*') { 367 | if (-not $groupMembers) { 368 | $groupMembers = Get-MembersFromGroup $group 369 | } 370 | 371 | if ($groupMembers) { 372 | $groupMembersSMTPAddresses = $groupMembers.PrimarySmtpAddress -join ';' 373 | } else { 374 | $groupMembersSMTPAddresses = '' 375 | } 376 | 377 | [PSCustomObject]@{ 378 | 'Group' = $group 379 | 380 | 'Group Name' = $group.Name 381 | 'Group GUID' = $group.Guid 382 | 'Group SMTP' = $group.WindowsEmailAddress 383 | 'Group Category' = $group.RecipientType 384 | 'Group Company' = $groupCompany 385 | 386 | 'Group Manager Properties' = $groupManagerProperties -join ';' 387 | 'Group Member Properties' = $groupMemberProperties -join ';' 388 | 'Group Managers Count' = $groupManagersCount 389 | 'Group Members Count' = $groupMembersCount 390 | 391 | 'First Company Managers Count' = $firstCompanyManagersCount 392 | 'First Company Members Count' = $firstCompanyMembersCount 393 | 'Second Company Managers Count' = $secondCompanyManagersCount 394 | 'Second Company Members Count' = $secondCompanyMembersCount 395 | 396 | 'Group Managers SMTP Addresses' = $groupManagersSMTPAddresses 397 | 'Group Managers Companies' = $groupManagersCompanies 398 | 399 | 'Group Members SMTP Addresses' = $groupMembersSMTPAddresses 400 | } | Export-Csv $params.outputFilePath -Append -NoTypeInformation 401 | } 402 | } 403 | 404 | Stop-Transcript 405 | } 406 | 407 | end { 408 | Send-DefaultReportMail -ScriptParams $params 409 | } 410 | -------------------------------------------------------------------------------- /Get-InactiveMailboxes.ps1: -------------------------------------------------------------------------------- 1 | param ( 2 | [Alias('IT')][Int]$InactiveThreshold 3 | ) 4 | 5 | begin { 6 | . "$PSScriptRoot\Initializer.ps1" 7 | $params = Invoke-Expression "Initialize-DefaultParam $args" 8 | 9 | $inactiveThresholdParams = @{ 10 | Name = 'InactiveThreshold' 11 | Value = $InactiveThreshold 12 | DefaultValue = 90 13 | Config = $params.config 14 | ScriptName = $params.scriptName 15 | } 16 | $inactiveThreshold = Read-Param @inactiveThresholdParams 17 | 18 | $inactiveSpan = New-TimeSpan -Days $inactiveThreshold 19 | $today = Get-Date 20 | } 21 | 22 | process { 23 | $allMailboxes = Get-Mailbox -ResultSize Unlimited | 24 | Where-Object { $_.WhenMailboxCreated -lt ($today - $inactiveSpan) } 25 | $allMailboxesStats = $allMailboxes | 26 | Get-MailboxStatistics -WarningAction SilentlyContinue -ErrorAction SilentlyContinue 27 | $inactiveMailboxes = $allMailboxesStats | 28 | Where-Object { ($_.LastLogonTime -lt ($today - $inactiveSpan)) -or 29 | ($_.LastLogonTime -eq $Null) } 30 | $inactiveMailboxesCount = $inactiveMailboxes | Measure-Object | 31 | Select-Object -ExpandProperty Count 32 | 33 | $output = @() 34 | Write-Output "To process $inactiveMailboxesCount inactive mailboxes" 35 | 36 | for ($index = 0; $index -lt $inactiveMailboxesCount; $index++) { 37 | $inactiveMailbox = $inactiveMailboxes[$index] 38 | Write-Output ( 39 | "Processing mailbox $($index + 1) / $inactiveMailboxesCount | " + 40 | "$($inactiveMailbox.DisplayName)" 41 | ) 42 | 43 | $mailbox = ($allMailboxes | 44 | Where-Object { $_.DisplayName -eq $inactiveMailbox.DisplayName }) 45 | 46 | if ($Null -eq $inactiveMailbox.LastLogonTime) { 47 | $inactiveSpanInactive = ($today - $mailbox.WhenMailboxCreated).Days 48 | } else { 49 | $inactiveSpanInactive = ($today - $inactiveMailbox.LastLogonTime).Days 50 | } 51 | 52 | $instance = ($inactiveMailbox | 53 | Select-Object @{ 54 | Label = 'Displayname'; 55 | Expression = { $mailbox.DisplayName } 56 | }, 57 | @{ 58 | Label = 'UserPrincipalName'; 59 | Expression = { $mailbox.UserPrincipalName } 60 | }, 61 | @{ 62 | Label = 'PrimarySmtpAddress'; 63 | Expression = { $mailbox.PrimarySmtpAddress } 64 | }, 65 | @{ 66 | Label = 'MailboxType'; 67 | Expression = { $mailbox.RecipientTypeDetails } 68 | }, 69 | @{ 70 | Label = 'MailboxCreatedon'; 71 | Expression = { $mailbox.WhenMailboxCreated } 72 | }, 73 | @{ 74 | Label = 'Lastloggedon'; 75 | Expression = { $Inactivemailbox.LastLogonTime } 76 | }, 77 | @{ 78 | Label = 'Inactive'; 79 | Expression = { $inactiveSpanInactive } 80 | } 81 | ) 82 | $output += $instance 83 | } 84 | } 85 | 86 | end { 87 | $output | Export-Csv $params.outputFilePath -Encoding UTF8 -NoTypeInformation 88 | 89 | Send-DefaultReportMail -ScriptParams $params 90 | } -------------------------------------------------------------------------------- /Get-MailTrafficReport.ps1: -------------------------------------------------------------------------------- 1 | begin { 2 | . "$PSScriptRoot\Initializer.ps1" 3 | $params = Invoke-Expression "Initialize-DefaultParam $args" 4 | } 5 | 6 | process { 7 | $serverName = $env:computername 8 | $beginDay = Get-Date -Hour 0 -Minute 00 -Second 00 9 | $endDay = $beginDay.AddDays(1).AddSeconds(-1) 10 | $outputFileName = $params.$intermediateOutputFilePath + 11 | $serverName + '_' + $beginDay.Day + '.' + $beginDay.Month + '.' + $beginDay.Year + '.csv' 12 | 13 | Get-MessageTrackingLog -Start $beginDay -End $endDay -EventID 'Receive' -ResultSize Unlimited | 14 | Where-Object { (Get-ExchangeServer).Fqdn -notcontains $_.ClientHostname } | 15 | Group-Object -Property ClientHostname, Sender | 16 | ForEach-Object -Process { 17 | New-Object -TypeName PSObject -Property @{ 18 | Timestamp = ($_.Group.Timestamp | Select-Object -First 1).ToString().Split(' ')[0] 19 | Count = $_.Count 20 | ClientHostname = $_.Name.Split(',')[0] 21 | Sender = $_.Name.Split(',')[1].Split(' ')[1] 22 | ClientComputedIP = 23 | (Resolve-DnsName ` 24 | -Name $_.Name.Split(',')[0] ` 25 | -Type A ` 26 | -ErrorAction SilentlyContinue | 27 | Select-Object ` 28 | -ExpandProperty IPAddress ` 29 | -ErrorAction SilentlyContinue) -join ';' 30 | } 31 | } | 32 | Sort-Object -Property Count -Descending | 33 | Select-Object Timestamp, ClientHostname, ClientComputedIP, Sender, Count | 34 | Export-Csv -Path $outputFileName -NoTypeInformation 35 | } 36 | -------------------------------------------------------------------------------- /Get-MailboxLocation.ps1: -------------------------------------------------------------------------------- 1 | begin { 2 | . "$PSScriptRoot\Initializer.ps1" 3 | $params = Invoke-Expression "Initialize-DefaultParam $args" 4 | } 5 | 6 | process { 7 | $exchangeObjectsCount = $params.exchangeObjects.Count 8 | 9 | Write-Output "To process $exchangeObjectsCount exchange objects" 10 | 11 | for ($index = 0; $index -lt $exchangeObjectsCount; $index++) { 12 | $exchangeObject = $params.exchangeObjects[$index] 13 | 14 | $location = Get-ExchangeObjectLocation -ExchangeObject $exchangeObject 15 | 16 | Write-Output ( 17 | "Processed exchange object $($index + 1) / $exchangeObjectsCount | " + 18 | "$exchangeObject | $location" 19 | ) 20 | 21 | [PSCustomObject]@{ 22 | exchangeObject = $exchangeObject 23 | mailboxLocation = $location 24 | } | Export-Csv $params.outputFilePath -Append -NoTypeInformation 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /Get-MailboxReport.ps1: -------------------------------------------------------------------------------- 1 | begin { 2 | . "$PSScriptRoot\Initializer.ps1" 3 | $params = Invoke-Expression "Initialize-DefaultParam $args" 4 | $mailboxPool = $params.exchangeObjects 5 | 6 | Write-Output 'Getting Exchange Online mailboxes...' 7 | $cloudMailboxes = $mailboxPool | 8 | Get-EXORecipient -RecipientType UserMailbox -ErrorAction SilentlyContinue 9 | $cloudMailboxesCount = @($cloudMailboxes).Count 10 | Write-Output "Found $cloudMailboxesCount Exchange Online mailboxes" 11 | 12 | Write-Output 'Getting Exchange Online mailboxes total sizes...' 13 | $cloudMailboxesTotalSizeMB = @() 14 | $cloudMailboxesTotalSizeMB = $mailboxPool | 15 | Get-EXORecipient -Properties ExchangeGuid -ErrorAction SilentlyContinue | 16 | Get-EXOMailboxStatistics $_.ExchangeGuid -ErrorAction SilentlyContinue | 17 | Select-Object MailboxGuid, @{ 18 | Name = 'TotalItemSizeinMB'; 19 | Expression = { 20 | [math]::Round( 21 | ($_.TotalItemSize.ToString(). 22 | Split('(')[1]. 23 | Split(' ')[0]. 24 | Replace(',', '') / 1MB) 25 | ) 26 | } 27 | } 28 | $cloudMailboxesTotalDeletedItemSizeMB = @() 29 | $cloudMailboxesTotalDeletedItemSizeMB = $mailboxPool | 30 | Get-EXORecipient -Properties ExchangeGuid -ErrorAction SilentlyContinue | 31 | Get-EXOMailboxStatistics $_.ExchangeGuid -ErrorAction SilentlyContinue | 32 | Select-Object MailboxGuid, @{ 33 | Name = 'TotalDeletedItemSizeinMB'; 34 | Expression = { 35 | [math]::Round( 36 | ($_.TotalDeletedItemSize.ToString(). 37 | Split('(')[1]. 38 | Split(' ')[0]. 39 | Replace(',', '') / 1MB) 40 | ) 41 | } 42 | } 43 | 44 | Write-Output 'Getting Exchange Online mailboxes'' archives total size...' 45 | $cloudMailboxesArchive = $mailboxPool | 46 | Get-EXOMailbox -ErrorAction SilentlyContinue | 47 | Select-Object ExchangeGuid, ArchiveName, ArchiveGuid 48 | $cloudMailboxesArchiveTotalSizeMB = @() 49 | $cloudMailboxesArchiveTotalSizeMB = $mailboxPool | 50 | Get-Recipient -ErrorAction SilentlyContinue -Filter 'ArchiveState -ne ''None''' | 51 | Get-EXOMailboxStatistics $_.ExchangeGuid -Archive -ErrorAction SilentlyContinue | 52 | Select-Object MailboxGuid, @{ 53 | Name = 'TotalItemSizeinMB'; 54 | Expression = { 55 | [math]::Round( 56 | ($_.TotalItemSize.ToString(). 57 | Split('(')[1]. 58 | Split(' ')[0]. 59 | Replace(',', '') / 1MB) 60 | ) 61 | } 62 | } 63 | $cloudMailboxesArchiveTotalDeletedItemSizeMB = @() 64 | $cloudMailboxesArchiveTotalDeletedItemSizeMB = $mailboxPool | 65 | Get-Recipient -ErrorAction SilentlyContinue -Filter 'ArchiveState -ne ''None''' | 66 | Get-EXOMailboxStatistics $_.ExchangeGuid -Archive -ErrorAction SilentlyContinue | 67 | Select-Object MailboxGuid, @{ 68 | Name = 'TotalDeletedItemSizeinMB'; 69 | Expression = { 70 | [math]::Round( 71 | ($_.TotalDeletedItemSize.ToString(). 72 | Split('(')[1]. 73 | Split(' ')[0]. 74 | Replace(',', '') / 1MB) 75 | ) 76 | } 77 | } 78 | } 79 | 80 | process { 81 | Write-Output "To process $cloudMailboxesCount Exchange Online mailboxes" 82 | for ($index = 0; $index -lt $cloudMailboxesCount; $index++) { 83 | $cloudMailbox = $cloudMailboxes[$index] 84 | Write-Output ( 85 | "`tProcessing mailbox $($index + 1) / $cloudMailboxesCount | $cloudMailbox" 86 | ) 87 | $cloudMailboxAliasUID = $cloudMailbox.Alias 88 | $cloudMailboxSamAccountName = $cloudMailbox.SamAccountName 89 | $cloudMailboxPrimarySMTPAddress = $cloudMailbox.PrimarySMTPAddress 90 | $cloudMailboxMailDomain = $cloudMailboxPrimarySMTPAddress.ToString().split('@')[1] 91 | $cloudMailboxUPN = $cloudMailbox.WindowsLiveId 92 | $cloudMailboxType = $cloudMailbox.RecipientTypeDetails 93 | if ($cloudMailboxType -like 'UserMailbox' -and $cloudMailboxSamAccountName -like 'SRV*') { 94 | $cloudMailboxType = 'ServiceMailbox' 95 | } 96 | $cloudMailboxDisplayName = $cloudMailbox.DisplayName 97 | $cloudMailboxEXOMailbox = Get-EXOMailbox $cloudMailboxAliasUID 98 | $cloudMailboxPlan = $cloudMailboxEXOMailbox | 99 | Select-Object -ExpandProperty Mailboxplan 100 | $cloudMailboxMaxSendSize = $cloudMailboxEXOMailbox | 101 | Select-Object -ExpandProperty MaxSendSize 102 | $cloudMailboxMaxReceiveSize = $cloudMailboxEXOMailbox | 103 | Select-Object -ExpandProperty MaxReceiveSize 104 | $cloudMailboxIssueWarningQuota = $cloudMailboxEXOMailbox | 105 | Select-Object -ExpandProperty IssueWarningQuota 106 | $cloudMailboxProhibitSendQuota = $cloudMailboxEXOMailbox | 107 | Select-Object -ExpandProperty ProhibitSendQuota 108 | $cloudMailboxProhibitSendReceiveQuota = $cloudMailboxEXOMailbox | 109 | Select-Object -ExpandProperty ProhibitSendReceiveQuota 110 | 111 | $cloudMailboxArchiveState = $cloudMailbox.ArchiveState 112 | $cloudMailboxSizeMB = $cloudMailboxesTotalSizeMB | 113 | Where-Object { 114 | $_.MailboxGuid -eq $cloudMailbox.ExchangeGuid 115 | } | 116 | Select-Object -ExpandProperty TotalItemSizeinMB 117 | $cloudMailboxTotalDeletedItemSizeMB = $cloudMailboxesTotalDeletedItemSizeMB | 118 | Where-Object { 119 | $_.MailboxGuid -eq $cloudMailbox.ExchangeGuid 120 | } | 121 | Select-Object -ExpandProperty TotalDeletedItemSizeinMB 122 | 123 | $cloudMailboxArchiveDisplayName = $null 124 | $cloudMailboxArchiveGuid = $null 125 | $cloudMailboxArchiveDeletedItemSizeMB = $null 126 | $cloudMailboxArchiveSizeMB = $null 127 | if ($cloudMailbox.ArchiveState -ne 'None') { 128 | $cloudMailboxArchiveDisplayName = 129 | $cloudMailboxesArchive | 130 | Where-Object { 131 | $_.ExchangeGuid -eq $cloudMailbox.ExchangeGuid 132 | } | 133 | Select-Object -ExpandProperty ArchiveName 134 | $cloudMailboxArchiveGuid = 135 | $cloudMailboxesArchive | 136 | Where-Object { 137 | $_.ExchangeGuid -eq $cloudMailbox.ExchangeGuid 138 | } | 139 | Select-Object -ExpandProperty ArchiveGuid 140 | $cloudMailboxArchiveDeletedItemSizeMB = 141 | $cloudMailboxesArchiveTotalDeletedItemSizeMB | 142 | Where-Object { 143 | $_.MailboxGuid -eq $cloudMailbox.ArchiveGuid 144 | } | 145 | Select-Object -ExpandProperty TotalDeletedItemSizeinMB 146 | $cloudMailboxArchiveSizeMB = 147 | $cloudMailboxesArchiveTotalSizeMB | 148 | Where-Object { 149 | $_.MailboxGuid -eq $cloudMailbox.ArchiveGuid 150 | } | 151 | Select-Object -ExpandProperty TotalItemSizeinMB 152 | } 153 | 154 | [PSCustomObject]@{ 155 | cloudMailboxAliasUID = $cloudMailboxAliasUID 156 | cloudMailboxDisplayName = $cloudMailboxDisplayName 157 | cloudMailboxSamAccountName = $cloudMailboxSamAccountName 158 | cloudMailboxUPN = $cloudMailboxUPN 159 | cloudMailboxPrimarySMTPAddress = $cloudMailboxPrimarySMTPAddress 160 | cloudMailboxMailDomain = $cloudMailboxMailDomain 161 | cloudMailboxType = $cloudMailboxType 162 | cloudMailboxPlan = $cloudMailboxPlan 163 | cloudMailboxArchiveState = $cloudMailboxArchiveState 164 | cloudMailboxMaxSendSize = $cloudMailboxMaxSendSize 165 | cloudMailboxMaxReceiveSize = $cloudMailboxMaxReceiveSize 166 | cloudMailboxIssueWarningQuota = $cloudMailboxIssueWarningQuota 167 | cloudMailboxProhibitSendQuota = $cloudMailboxProhibitSendQuota 168 | cloudMailboxProhibitSendReceiveQuota = $cloudMailboxProhibitSendReceiveQuota 169 | cloudMailboxTotalDeletedItemSizeMB = $cloudMailboxTotalDeletedItemSizeMB 170 | cloudMailboxSizeMB = $cloudMailboxSizeMB 171 | cloudMailboxArchiveDisplayName = $cloudMailboxArchiveDisplayName 172 | cloudMailboxArchiveGuid = $cloudMailboxArchiveGuid 173 | cloudMailboxArchiveDeletedItemSizeMB = $cloudMailboxArchiveDeletedItemSizeMB 174 | cloudMailboxArchiveSizeMB = $cloudMailboxArchiveSizeMB 175 | } | Export-Csv $params.outputFilePath -Append -NoTypeInformation 176 | } 177 | } 178 | 179 | end { 180 | Send-DefaultReportMail -ScriptParams $params 181 | } -------------------------------------------------------------------------------- /Get-MailboxStatsReport.ps1: -------------------------------------------------------------------------------- 1 | begin { 2 | . "$PSScriptRoot\Initializer.ps1" 3 | $params = Invoke-Expression "Initialize-DefaultParam $args" 4 | } 5 | 6 | process { 7 | Get-Mailbox -ResultSize Unlimited | 8 | Get-MailboxStatistics | 9 | Select-Object -ExpandProperty TotalItemSize | 10 | Select-Object -ExpandProperty Value | 11 | Select-Object @{ 12 | Name = 'TotalItemSizeinMB'; 13 | Expression = { 14 | [math]::Round( 15 | ($_.ToString(). 16 | Split('(')[1]. 17 | Split(' ')[0]. 18 | Replace(',', '') / 1MB) 19 | ) 20 | } 21 | } | 22 | Select-Object -ExpandProperty TotalItemSizeinMB | 23 | Measure-Object -Average -Sum -Minimum -Maximum | 24 | Export-Csv $params.outputFilePath -NoTypeInformation 25 | } 26 | 27 | end { 28 | Send-DefaultReportMail -ScriptParams $params 29 | } 30 | -------------------------------------------------------------------------------- /Initializer.ps1: -------------------------------------------------------------------------------- 1 | . "$PSScriptRoot\Utilities.ps1" 2 | 3 | Set-StrictMode -Version Latest 4 | 5 | function Get-ScriptName { 6 | $callStack = Get-PSCallStack 7 | $scriptFileName = $callStack[1].Command 8 | 9 | return [IO.Path]::GetFileNameWithoutExtension($scriptFileName) 10 | } 11 | 12 | function Initialize-DefaultParam { 13 | [CmdletBinding()] 14 | [OutputType([Hashtable])] 15 | param ( 16 | [String]$_ScriptName = (Get-ScriptName), 17 | 18 | [Alias('IP')][String]$InputPath, 19 | [Alias('ID')][String]$InputDir, 20 | [Alias('IFN')][String]$InputFileName, 21 | 22 | [Alias('OP')][String]$OutputPath, 23 | [Alias('OD')][String]$OutputDir, 24 | [Alias('OFN')][String]$OutputFileName, 25 | 26 | [Alias('EO')][String[]]$ExchangeObjects 27 | ) 28 | 29 | begin { 30 | function Initialize-IniModule { 31 | Set-Variable 'iniModule' -Option Constant -Value 'PsIni' 32 | 33 | $isModuleInstalled = Get-Module $iniModule -ListAvailable 34 | 35 | if (-not $isModuleInstalled) { 36 | Install-Module $iniModule -AcceptLicense 37 | } 38 | 39 | Import-Module $iniModule -Verbose:$false 40 | } 41 | 42 | function Get-Config { 43 | Set-Variable 'configDirectoryPath' -Option Constant -Value "$HOME\.config" 44 | Set-Variable 'configFilePath' -Option Constant -Value ( 45 | Join-Path $configDirectoryPath -ChildPath 'manage-exchange_server.ini' 46 | ) 47 | 48 | Initialize-IniModule 49 | 50 | if (Test-Path $configFilePath -PathType Leaf) { 51 | # Read the existing config file. 52 | $config = Get-IniContent $configFilePath 53 | } else { 54 | # Create the `.config` folder if it doesn't exist. 55 | New-Item $configDirectoryPath ` 56 | -ItemType Directory ` 57 | -ErrorAction SilentlyContinue > $null 58 | 59 | # Create a default, empty config data. 60 | $config = [Ordered]@{ 61 | $configGlobalCategory = @{} 62 | } 63 | 64 | # Save the created config data in the file. 65 | Out-IniFile $configFilePath -InputObject $config 66 | } 67 | 68 | return $config 69 | } 70 | } 71 | 72 | process { 73 | # Load the config. 74 | $config = Get-Config 75 | 76 | # Set timestamp variable. 77 | $timestamp = Get-Date -Format 'yyyyMMdd_HHmmss' 78 | 79 | # Read the params. 80 | $inputPathParams = @{ 81 | Name = 'InputPath' 82 | Value = $InputPath 83 | DefaultValue = "$HOME" 84 | Config = $config 85 | ScriptName = $_ScriptName 86 | AllowGlobal = $true 87 | } 88 | $inputPath = Read-Param @inputPathParams 89 | 90 | $inputDirParams = @{ 91 | Name = 'InputDir' 92 | Value = $InputDir 93 | Config = $config 94 | ScriptName = $_ScriptName 95 | AllowGlobal = $true 96 | } 97 | $inputDir = Read-Param @$inputDirParams 98 | 99 | $inputFileNameParams = @{ 100 | Name = 'InputFileName' 101 | Value = $InputFileName 102 | DefaultValue = "input_$_ScriptName.csv" 103 | Config = $config 104 | ScriptName = $_ScriptName 105 | AllowGlobal = $true 106 | } 107 | $inputFileName = Read-Param @inputFileNameParams 108 | 109 | $outputPathParams = @{ 110 | Name = 'OutputPath' 111 | Value = $OutputPath 112 | DefaultValue = "$HOME" 113 | Config = $config 114 | ScriptName = $_ScriptName 115 | AllowGlobal = $true 116 | } 117 | $outputPath = Read-Param @outputPathParams 118 | 119 | $outputDirParams = @{ 120 | Name = 'OutputDir' 121 | Value = $OutputDir 122 | Config = $config 123 | ScriptName = $_ScriptName 124 | AllowGlobal = $true 125 | } 126 | $outputDir = Read-Param @outputDirParams 127 | 128 | $outputFileNameParams = @{ 129 | Name = 'OutputFileName' 130 | Value = $OutputFileName 131 | DefaultValue = "output_$_ScriptName.$timestamp.csv" 132 | Config = $config 133 | ScriptName = $_ScriptName 134 | AllowGlobal = $true 135 | } 136 | $outputFileName = Read-Param @outputFileNameParams 137 | 138 | $intermediateInputFilePath = Join-Path $inputPath -ChildPath $inputDir 139 | $intermediateOutputFilePath = Join-Path $outputPath -ChildPath $outputDir 140 | $inputFilePath = Join-Path $intermediateInputFilePath -ChildPath $inputFileName 141 | $outputFilePath = Join-Path $intermediateOutputFilePath -ChildPath $outputFileName 142 | 143 | if (-not (Test-Path $intermediateOutputFilePath -PathType Container)) { 144 | New-Item $intermediateOutputFilePath ` 145 | -ItemType Directory ` 146 | -ErrorAction SilentlyContinue > $null 147 | } 148 | 149 | $exchangeObjectsParams = @{ 150 | Name = 'ExchangeObjects' 151 | Value = $ExchangeObjects 152 | DefaultValue = (Get-Content $inputFilePath -ErrorAction SilentlyContinue) 153 | AllowGlobal = $true 154 | } 155 | $exchangeObjects = Read-Param @exchangeObjectsParams 156 | 157 | if ($null -eq $exchangeObjects) { 158 | $exchangeObjects = @() 159 | } 160 | } 161 | 162 | end { 163 | Write-Verbose "scriptName: $_ScriptName" 164 | Write-Verbose "config: $($config | ConvertTo-Json)" 165 | Write-Verbose "inputFilePath: $inputFilePath" 166 | Write-Verbose "outputFilePath: $outputFilePath" 167 | Write-Verbose "exchangeObjects.Count: $($exchangeObjects.Count)" 168 | 169 | return @{ 170 | scriptName = $_ScriptName 171 | config = $config 172 | 173 | inputPath = $inputPath 174 | inputDir = $inputDir 175 | inputFileName = $inputFileName 176 | inputFilePath = $inputFilePath 177 | 178 | outputPath = $outputPath 179 | outputDir = $outputDir 180 | outputFileName = $outputFileName 181 | outputFilePath = $outputFilePath 182 | 183 | exchangeObjects = $exchangeObjects 184 | } 185 | } 186 | } 187 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /PSScriptAnalyzerSettings.psd1: -------------------------------------------------------------------------------- 1 | @{ 2 | ExcludeRules = @( 3 | 'PSAvoidUsingInvokeExpression' 4 | ) 5 | Rules = @{ 6 | PSAvoidLongLines = @{ 7 | Enable = $true 8 | MaximumLineLength = 100 9 | } 10 | PSAvoidUsingDoubleQuotesForConstantString = @{ 11 | Enable = $true 12 | } 13 | PSPlaceCloseBrace = @{ 14 | Enable = $true 15 | NewLineAfter = $false 16 | NoEmptyLineBefore = $true 17 | } 18 | PSPlaceOpenBrace = @{ 19 | Enable = $true 20 | } 21 | PSUseCompatibleSyntax = @{ 22 | Enable = $true 23 | TargetVersions = @( 24 | '5.0', 25 | '6.0', 26 | '7.0' 27 | ) 28 | } 29 | PSUseConsistentIndentation = @{ 30 | Enable = $true 31 | } 32 | PSUseConsistentWhitespace = @{ 33 | Enable = $true 34 | CheckPipeForRedundantWhitespace = $true 35 | } 36 | } 37 | } 38 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Manage-ExchangeServer 2 | 3 | PowerShell scripts for Management / Reporting within Exchange On Premises / 4 | Online. 5 | 6 | ## Config file 7 | 8 | Upon running any script for the first time, a default config file will be 9 | created for you. You can also manually create it beforehand at the path 10 | `$HOME/.config/manage-exchange_server.ini`, making sure that the required 11 | sections are also included. 12 | 13 | The config file is used to define default values for the common parameters. 14 | These can be global, which apply to all the scripts, or specific, which apply to 15 | a specific script. 16 | 17 | These are used as a list of fall-backs, meaning, a valid value will be searched 18 | in a specific order until one is found. 19 | 20 | So the value used for a parameter will be: 21 | 1. The value specified on the command line if available, 22 | 2. Else, the value specified in the specific section of the config file for the 23 | respective script if available, 24 | 3. Else, the value specified in the `Global` section of the config file if 25 | available, 26 | 4. Else, a sensible default value defined by this project. 27 | 28 | The syntax for a parameter value is: 29 | 30 | ```ini 31 | ParamName=value 32 | ``` 33 | 34 | As a reference, here is a sample config file specifying global values for all 35 | the parameters and specific values for several scripts: 36 | 37 | ```ini 38 | [Global] 39 | InputPath=C:\exchange 40 | InputDir=inputs 41 | InputFileName=input.csv 42 | 43 | OutputPath=C:\exchange 44 | OutputDir=outputs 45 | OutputFileName=output.csv 46 | 47 | ReportMailFrom=noreply@domain.com 48 | ReportMailTo=recipient@domain.com 49 | ReportMailCC= 50 | ReportMailSMTPHost=smtp.domain.com 51 | 52 | [Set-MailboxQuota] 53 | InputPath=C:\quotas 54 | InputDir=inputs 55 | InputFileName=users_list.csv 56 | 57 | OutputPath=C:\quotas 58 | OutputDir=outputs 59 | OutputFileName=result.csv 60 | 61 | [Resolve-PendingMigrations] 62 | InputFileName=input_Resolve-PendingMigrations.csv 63 | OutputDir=Resolve-PendingMigrations 64 | OutputFileName=output_Resolve-PendingMigrations.csv 65 | ItemCountThreshold=100 66 | 67 | [Get-GroupsReport] 68 | FirstCompanyIdentifier=compA 69 | FirstCompanyName=CompanyA 70 | SecondCompanyIdentifier=compB 71 | SecondCompanyName=CompanyB 72 | CompanyIdentifierAttribute=Department 73 | ``` 74 | 75 | ## Parameters 76 | 77 | There are some parameters that are available to all the scripts, for which you 78 | can also configure default values in the config file as described in the 79 | [`Config` section](#config). 80 | 81 | Here is the list of these generally available parameters, along with their 82 | respective aliases: 83 | 84 | Name | Alias 85 | --- | --- 86 | `-InputPath` | IP 87 | `-InputDir` | ID 88 | `-InputFileName` | IFN 89 | `-OutputPath` | OP 90 | `-OutputDir` | OD 91 | `-OutputFileName` | OFN 92 | `-ExchangeObjects` | EO 93 | 94 | _Note: In order to leverage this setup, you need to initialize any new script with:_ 95 | 96 | ```pwsh 97 | begin { 98 | . "$PSScriptRoot\Initializer.ps1" 99 | $params = Invoke-Expression "Initialize-DefaultParams $args" 100 | } 101 | ``` 102 | 103 | _Note: When you need to specify multiple values for the `-ExchangeObjects` 104 | param, you have to enclose them in single quotes like: `-ExchangeObjects 105 | 'first.user@example.com,second.user@example.com'`._ 106 | 107 | _Note: It's not guaranteed that all of the scripts are using all of these 108 | parameters. Some scripts might even decide not to use any of them._ 109 | -------------------------------------------------------------------------------- /Remove-SpecificAlias.ps1: -------------------------------------------------------------------------------- 1 | param ( 2 | [Alias('AI')][SupportsWildcards()][string]$AliasIdentifier 3 | ) 4 | 5 | begin { 6 | . "$PSScriptRoot\Initializer.ps1" 7 | $params = Invoke-Expression "Initialize-DefaultParam $args" 8 | 9 | $aliasIdentifierParams = @{ 10 | Name = 'AliasIdentifier' 11 | Value = $AliasIdentifier 12 | Config = $params.config 13 | ScriptName = $params.scriptName 14 | } 15 | $aliasIdentifier = Read-Param @aliasIdentifierParams 16 | } 17 | 18 | process { 19 | foreach ($exchangeObject in $params.exchangeObjects) { 20 | $aliasToRemove = Get-Recipient $exchangeObject | 21 | Select-Object -Property @{ 22 | Name = 'SpecificEmailAddresses'; 23 | Expression = { 24 | $_.EmailAddresses | 25 | Where-Object { $_ -like "$aliasIdentifier" } 26 | } 27 | } | Select-Object -ExpandProperty SpecificEmailAddresses 28 | foreach ($alias in $aliasToRemove) { 29 | $aliasToRemoveParams = @{ 30 | EmailAddresses = @{ remove = "$alias" } 31 | EmailAddressPolicyEnabled = $false 32 | } 33 | Set-RemoteMailbox $exchangeObject @aliasToRemoveParams 34 | } 35 | } 36 | } -------------------------------------------------------------------------------- /Resolve-PendingMigrations.ps1: -------------------------------------------------------------------------------- 1 | param ( 2 | [Alias('BIC')][Switch]$BypassItemCount, 3 | [Alias('ICT')][Int]$ItemCountThreshold 4 | ) 5 | 6 | begin { 7 | . "$PSScriptRoot\Initializer.ps1" 8 | $params = Invoke-Expression "Initialize-DefaultParam $args" 9 | 10 | $itemCountThresholdParams = @{ 11 | Name = 'ItemCountThreshold' 12 | Value = $ItemCountThreshold 13 | DefaultValue = 50 14 | Config = $params.config 15 | ScriptName = $params.scriptName 16 | } 17 | $itemCountThreshold = Read-Param @itemCountThresholdParams 18 | 19 | $routingAddress = ( 20 | Get-OrganizationConfig | 21 | Select-Object -ExpandProperty MicrosoftExchangeRecipientEmailAddresses | 22 | Where-Object { $_ -like '*mail.onmicrosoft.com' } 23 | ).Split('@')[1] 24 | } 25 | 26 | process { 27 | foreach ($exchangeObject in $params.exchangeObjects) { 28 | $itemCount = Get-MailboxFolderStatistics $exchangeObject | 29 | Where-Object { $_.FolderType -eq 'Root' } | 30 | Select-Object -ExpandProperty ItemsInFolderAndSubfolders 31 | 32 | if ($itemCount -le $itemCountThreshold -or $BypassItemCount) { 33 | $mailboxInfo = Get-Mailbox -Identity $exchangeObject 34 | 35 | foreach ($emailAddress in $mailboxInfo.EmailAddresses) { 36 | [PSCustomObject]@{ 37 | exchangeObject = $exchangeObject 38 | emailAddress = $emailAddress 39 | } | Export-Csv $params.outputFilePath -Append -NoTypeInformation 40 | } 41 | 42 | $hasArchiveGuid = $mailboxInfo.archiveGuid -ne '00000000-0000-0000-0000-000000000000' 43 | $hasArchive = $hasArchiveGuid -and $mailboxInfo.archiveDatabase 44 | 45 | if (-not $hasArchive) { 46 | Disable-Mailbox -Identity $mailboxInfo.Alias -Confirm:$false 47 | Enable-RemoteMailbox $mailboxInfo.Alias ` 48 | -RemoteRoutingAddress "$exchangeObject@$routingAddress" 49 | Set-RemoteMailbox $mailboxInfo.UserPrincipalName ` 50 | -EmailAddresses $mailboxInfo.EmailAddresses ` 51 | -EmailAddressPolicyEnabled $false 52 | } else { 53 | $errorMessage = -join ( 54 | "Mailbox $exchangeObject has on-premise archive enabled. Processing the ", 55 | 'script requires permanently disabling the archive which will result in data ', 56 | 'loss. Consider merging the 2 mailbox objects manually after backup. Skipping ', 57 | 'this mailbox...' 58 | ) 59 | 60 | Write-Error $errorMessage 61 | } 62 | } else { 63 | $errorMessage = -join ( 64 | "Mailbox $exchangeObject has on-premise content above threshold. Processing the ", 65 | 'script requires permanently disabling the mailbox which will result in data ', 66 | 'loss. Consider merging the 2 mailbox objects manually after backup. Skipping ', 67 | 'this mailbox...' 68 | ) 69 | 70 | Write-Error $errorMessage 71 | } 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /Set-MailboxQuota.ps1: -------------------------------------------------------------------------------- 1 | param ( 2 | [String]$SizeFieldName = 'TotalItemSizeInGB', 3 | 4 | [String]$DefaultProhibitSendReceiveQuota = '100GB', 5 | [String]$DefaultRecoverableItemsQuota = '30GB', 6 | [String]$DefaultRecoverableItemsWarningQuota = '20GB', 7 | 8 | [Int]$MailboxMinimumQuotaDifference = 1, 9 | [Int]$MailboxMinimumQuota = 2, 10 | [Float]$MailboxQuotaStep = 0.5, 11 | 12 | [Int]$ArchiveMinimumQuotaDifference = 1, 13 | [Int]$ArchiveMinimumQuota = 5, 14 | [Float]$ArchiveQuotaStep = 5.0 15 | ) 16 | 17 | begin { 18 | . "$PSScriptRoot\Initializer.ps1" 19 | $params = Invoke-Expression "Initialize-DefaultParam $args" 20 | } 21 | 22 | process { 23 | function Get-QuotaForSize { 24 | <# 25 | .SYNOPSIS 26 | Compute and return a quota based on the input size based on specific 27 | step, minimum quota and minimum difference between size and quota. 28 | 29 | .EXAMPLE 30 | Get-QuotaForSize 31 | -Size 1.2 32 | -MinimumDifference 1 33 | -MinimumQuota 2 34 | -Step 0.5 35 | 36 | This returns 2.5. 37 | #> 38 | param ( 39 | [Double]$Size, 40 | [Double]$MinimumDifference, 41 | [Double]$MinimumQuota, 42 | [Double]$Step 43 | ) 44 | 45 | $upscaledQuotaStep = [Math]::Ceiling($Step) / $Step 46 | 47 | $upscaledSize = ($Size + $MinimumDifference) * $upscaledQuotaStep 48 | $downscaledQuota = [Math]::Ceiling($upscaledSize) / $upscaledQuotaStep 49 | 50 | [Math]::Max($downscaledQuota, $MinimumQuota) 51 | } 52 | 53 | function Get-BytesFromGigaByte { 54 | <# 55 | .SYNOPSIS 56 | Compute and return a quota based on the input size based on specific 57 | step, minimum quota and minimum difference between size and quota. 58 | 59 | .EXAMPLE 60 | Get-QuotaFromSize -GigaBytes 1.2 61 | 62 | This returns 2.5. 63 | #> 64 | param ( 65 | [Double]$GigaBytes 66 | ) 67 | 68 | [Math]::Round($GigaBytes * [Math]::Pow(2, 30)) 69 | } 70 | 71 | foreach ($exchangeObject in $params.exchangeObjects) { 72 | $mailboxSizeGigaBytes = Get-MailboxStatistics -Identity $exchangeObject | 73 | Select-Object @{ 74 | Name = $SizeFieldName 75 | Expression = { 76 | [Math]::Round( 77 | ( 78 | $_. 79 | TotalItemSize. 80 | ToString(). 81 | Split('(')[1]. 82 | Split(' ')[0]. 83 | Replace(',', '') / 1GB 84 | ), 85 | 2 86 | ) 87 | } 88 | } | 89 | Select-Object $SizeFieldName -ExpandProperty $SizeFieldName 90 | 91 | $mailboxDesiredQuotaGigaBytes = Get-QuotaForSize ` 92 | -Size $mailboxSizeGigaBytes ` 93 | -MinimumDifference $MailboxMinimumQuotaDifference ` 94 | -MinimumQuota $MailboxMinimumQuota ` 95 | -Step $MailboxQuotaStep 96 | $mailboxDesiredQuotaBytes = Get-BytesFromGigaByte -GigaBytes $mailboxDesiredQuotaGigaBytes 97 | 98 | $movingProhibitSendQuota = $mailboxDesiredQuotaBytes 99 | $movingIssueWarningQuota = [Math]::Round($mailboxDesiredQuotaBytes * 0.9) 100 | 101 | Set-Mailbox $exchangeObject ` 102 | -UseDatabaseQuotaDefaults $false ` 103 | -ProhibitSendQuota $movingProhibitSendQuota ` 104 | -ProhibitSendReceiveQuota $DefaultProhibitSendReceiveQuota ` 105 | -RecoverableItemsQuota $DefaultRecoverableItemsQuota ` 106 | -RecoverableItemsWarningQuota $DefaultRecoverableItemsWarningQuota ` 107 | -IssueWarningQuota $movingIssueWarningQuota 108 | 109 | $mailboxInfo = Get-Mailbox -Identity $exchangeObject 110 | $hasArchiveGuid = $mailboxInfo.archiveGuid -ne '00000000-0000-0000-0000-000000000000' 111 | $hasArchive = $hasArchiveGuid -and $mailboxInfo.archiveDatabase 112 | 113 | if ($hasArchive) { 114 | $archiveSizeGigaBytes = Get-MailboxStatistics -Identity $exchangeObject -Archive | 115 | Select-Object @{ 116 | Name = $SizeFieldName 117 | Expression = { 118 | [Math]::Round( 119 | ( 120 | $_. 121 | TotalItemSize. 122 | ToString(). 123 | Split('(')[1]. 124 | Split(' ')[0]. 125 | Replace(',', '') / 1GB 126 | ), 127 | 2 128 | ) 129 | } 130 | } | 131 | Select-Object $SizeFieldName -ExpandProperty $SizeFieldName 132 | } else { 133 | $archiveSizeGigaBytes = 0 134 | } 135 | 136 | $archiveDesiredQuotaGigaBytes = Get-QuotaForSize ` 137 | -Size $archiveSizeGigaBytes ` 138 | -MinimumDifference $ArchiveMinimumQuotaDifference ` 139 | -MinimumQuota $ArchiveMinimumQuota ` 140 | -Step $ArchiveQuotaStep 141 | $archiveDesiredQuotaBytes = Get-BytesFromGigaByte -GigaBytes $archiveDesiredQuotaGigaBytes 142 | 143 | $movingArchiveQuota = $archiveDesiredQuotaBytes 144 | $movingArchiveWarningQuota = [Math]::Round($archiveDesiredQuotaBytes * 0.9) 145 | 146 | Set-Mailbox $exchangeObject ` 147 | -UseDatabaseQuotaDefaults $false ` 148 | -ArchiveQuota $movingArchiveQuota ` 149 | -ArchiveWarningQuota $movingArchiveWarningQuota 150 | } 151 | } 152 | -------------------------------------------------------------------------------- /Utilities.ps1: -------------------------------------------------------------------------------- 1 | using namespace System.Management.Automation 2 | 3 | if (-not (Test-Path variable:global:configGlobalCategory)) { 4 | $params = @{ 5 | Name = 'configGlobalCategory' 6 | Option = [ScopedItemOptions]::Constant 7 | Scope = 'Global' 8 | Value = 'Global' 9 | Visibility = [SessionStateEntryVisibility]::Private 10 | } 11 | Set-Variable @params 12 | } 13 | 14 | function Read-Param { 15 | param ( 16 | [String]$Name, 17 | [Object[]]$Value, 18 | [Object[]]$DefaultValue, 19 | 20 | [Hashtable]$Config, 21 | [String]$ScriptName, 22 | [Switch]$AllowGlobal 23 | ) 24 | 25 | if ($Value) { 26 | # Return the actual value if it exists. 27 | return $Value 28 | } 29 | 30 | if ($Config) { 31 | # Return a value from the config file if it exists. 32 | 33 | $key = $Name 34 | 35 | $specificCategory = $ScriptName 36 | 37 | if ($Config[$specificCategory]) { 38 | $specificValue = $Config[$specificCategory][$key] 39 | 40 | if ($specificValue) { 41 | # Return the specific value from the config file if it exists. 42 | return $specificValue 43 | } 44 | } 45 | 46 | if ($AllowGlobal) { 47 | $globalValue = $Config[$configGlobalCategory][$key] 48 | 49 | if ($globalValue) { 50 | # Return the global value from the config file if it exists. 51 | return $globalValue 52 | } 53 | } 54 | } 55 | 56 | if ($DefaultValue) { 57 | # Return the default value if it exists. 58 | return $DefaultValue 59 | } 60 | 61 | # Return null otherwise. 62 | return $null 63 | } 64 | 65 | enum ExchangeObjectLocation { 66 | notAvailable 67 | exchangeOnPremises 68 | exchangeOnline 69 | } 70 | 71 | function Get-ExchangeObjectLocation { 72 | param ( 73 | [String]$ExchangeObject 74 | ) 75 | 76 | $exchangeObjectTypeDetails = ( 77 | Get-Recipient -Identity $ExchangeObject -ErrorAction SilentlyContinue 78 | ) | Select-Object -ExpandProperty RecipientTypeDetails -ErrorAction SilentlyContinue 79 | 80 | $isLocal = $exchangeObjectTypeDetails -like '*Mailbox' 81 | $isRemote = $exchangeObjectTypeDetails -like 'Remote*' 82 | $isMailUser = $exchangeObjectTypeDetails -eq 'MailUser' 83 | 84 | $sessionScope = Get-PSSession | 85 | Where-Object { $_.State -eq 'Opened' -and $_.ConfigurationName -eq 'Microsoft.Exchange' } | 86 | Select-Object -ExpandProperty ComputerName 87 | 88 | if ($sessionScope -eq 'outlook.office365.com') { 89 | if ($isLocal) { 90 | return [ExchangeObjectLocation]::exchangeOnline 91 | } elseif ($isMailUser) { 92 | $errorMessage = -join ( 93 | 'You ran the script from PowerShell connected to Exchange Online ', 94 | "and recipient $exchangeObject is of type $exchangeObjectTypeDetails ", 95 | 'which means that either its mailbox is located remotely or that this is a ', 96 | 'mail user with no mailbox attached. Please consider running this script ', 97 | 'from PowerShell connected to Exchange On Premises for accurate results.' 98 | ) 99 | return $errorMessage 100 | } 101 | } else { 102 | if ($isLocal -and (-not $isRemote)) { 103 | return [ExchangeObjectLocation]::exchangeOnPremises 104 | } elseif ($isRemote) { 105 | return [ExchangeObjectLocation]::exchangeOnline 106 | } else { 107 | return [ExchangeObjectLocation]::notAvailable 108 | } 109 | } 110 | } 111 | 112 | function Send-ReportMail { 113 | param ( 114 | [String]$From, 115 | [String]$To, 116 | [String]$CC, 117 | 118 | [String]$AttachmentFilePath, 119 | [String]$AttachmentFileName, 120 | 121 | [String]$SMTPHost 122 | ) 123 | 124 | $attachment = New-Object Net.Mail.Attachment($AttachmentFilePath) 125 | 126 | $message = New-Object Net.Mail.MailMessage 127 | 128 | $message.From = $From 129 | $message.To.Add($To) 130 | 131 | if (-not [string]::IsNullOrEmpty($CC)) { 132 | $message.Cc.Add($CC) 133 | } 134 | 135 | $message.Subject = "$AttachmentFileName report is ready" 136 | $message.Body = "Attached is the $AttachmentFileName report" 137 | 138 | $message.Attachments.Add($attachment) 139 | 140 | $smtp = New-Object Net.Mail.SmtpClient($SMTPHost) 141 | $smtp.Send($message) 142 | } 143 | 144 | function Send-DefaultReportMail { 145 | param ( 146 | [Hashtable]$ScriptParams 147 | ) 148 | 149 | $fromParams = @{ 150 | Name = 'ReportMailFrom' 151 | Config = $ScriptParams.config 152 | ScriptName = $ScriptParams.scriptName 153 | AllowGlobal = $true 154 | } 155 | $from = Read-Param @fromParams 156 | 157 | $toParams = @{ 158 | Name = 'ReportMailTo' 159 | Config = $ScriptParams.config 160 | ScriptName = $ScriptParams.scriptName 161 | AllowGlobal = $true 162 | } 163 | $to = Read-Param @toParams 164 | 165 | $ccParams = @{ 166 | Name = 'ReportMailCC' 167 | Config = $ScriptParams.config 168 | ScriptName = $ScriptParams.scriptName 169 | AllowGlobal = $true 170 | } 171 | $cc = Read-Param @ccParams 172 | 173 | $smtpHostParams = @{ 174 | Name = 'ReportMailSMTPHost' 175 | Config = $ScriptParams.config 176 | ScriptName = $ScriptParams.scriptName 177 | AllowGlobal = $true 178 | } 179 | $smtpHost = Read-Param @smtpHostParams 180 | 181 | $mailParams = @{ 182 | From = $from 183 | To = $to 184 | CC = $cc 185 | 186 | AttachmentFilePath = $ScriptParams.outputFilePath 187 | AttachmentFileName = $ScriptParams.outputFileName 188 | 189 | SMTPHost = $smtpHost 190 | } 191 | Send-ReportMail @mailParams 192 | } 193 | --------------------------------------------------------------------------------