Repository navigation
Expand file tree
/
Copy pathGetAddInForAllUsers.ps1
More file actions
208 lines (182 loc) · 7.97 KB
/
Copy pathGetAddInForAllUsers.ps1
File metadata and controls
208 lines (182 loc) · 7.97 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# .SYNOPSIS
# Reports the deployment state of the Exclaimer Cloud Add-in for every active mailbox
# in a Microsoft 365 tenant, including the installed add-in version, whether it is
# enabled, and how it was deployed. Read-only; makes no changes to any mailbox.
#
# .DESCRIPTION
# Checks that the ExchangeOnlineManagement module is installed and offers to install it
# (current user scope) if it is missing. Prompts for a Microsoft sign-in with
# Connect-ExchangeOnline, or reuses an existing Exchange Online session.
#
# Retrieves all mailboxes where the account is not disabled, then runs Get-App against
# each one for the Exclaimer Cloud Add-in ID (default: efc30400-2ac5-48b7-8c9b-c0fd5f266be2;
# override with -AddInID). For every mailbox it records the add-in version (AppVersion),
# enabled state (Enabled), and the deployment type returned by Get-App (Deployment_Method).
#
# Output:
# - Main CSV with one row per mailbox: GetAddInForAllUsers_<timestamp>.csv
# - Error CSV, created only if errors occur: GetAddInForAllUsers_<timestamp>_errors.csv
# - Console summary: total mailboxes, mailboxes with the add-in, mailboxes with no
# add-in found, and error count
# Files are saved to the Downloads folder, falling back to C:\Temp if Downloads does not
# exist. The output folder opens when the script finishes.
#
# Use -VerboseLogging to also write a full session transcript to the same folder.
#
# Note: Get-App throws when the add-in is not present for a mailbox, so a mailbox without
# the add-in is expected to appear in the Errors count and error CSV rather than under
# "No add-in found" (inferred from the script logic, not confirmed against output).
# Review the Error column to tell "add-in not deployed" apart from other failures.
#
# .NOTES
# Created: 25th January 2024
# Updated: 7th October 2024
#
# .PRODUCTS
# Exclaimer Signature Management - Microsoft 365
#
# .REQUIREMENTS
# - Global Administrator access to the Microsoft Tenant
# - ExchangeOnlineManagement module
#
# .VERSION
# 1.1.0
param(
[string]$AddInID = "efc30400-2ac5-48b7-8c9b-c0fd5f266be2",
[switch]$VerboseLogging = $false
)
# Preferred output path (Downloads → fallback C:\Temp)
$OutputPath = [System.IO.Path]::Combine([Environment]::GetFolderPath('UserProfile'), 'Downloads')
if (-not (Test-Path -Path $OutputPath)) {
$OutputPath = "C:\Temp"
if (-not (Test-Path -Path $OutputPath)) {
New-Item -Path $OutputPath -ItemType Directory -Force | Out-Null
}
}
# File naming
$TimeStamp = Get-Date -Format 'yyyyMMdd_HHmmss'
$CsvFilePath = Join-Path $OutputPath "GetAddInForAllUsers_$TimeStamp.csv"
$TranscriptLogFile = Join-Path $OutputPath "Transcript_$TimeStamp.txt"
# Start transcript if enabled
if ($VerboseLogging) {
Write-Output "Verbose Logging Enabled: $TranscriptLogFile"
Start-Transcript -Path $TranscriptLogFile -Append -NoClobber
}
# Function to check and install required module
function Ensure_ModuleInstalled {
if (-not (Get-Module -ListAvailable -Name ExchangeOnlineManagement)) {
Write-Host "`nThe required 'ExchangeOnlineManagement' Module is NOT installed" -ForegroundColor Red
$installMsModule = Read-Host "Do you want to install the required 'ExchangeOnlineManagement' Module? Y/n"
if ($installMsModule -eq "Y") {
try {
Install-Module ExchangeOnlineManagement -Scope CurrentUser -Force
Write-Host "`n'ExchangeOnlineManagement' Module installed successfully." -ForegroundColor Green
} catch {
Write-Host "Failed to install module. Error: $_" -ForegroundColor Red
Exit
}
} else {
Write-Host "Cannot continue without 'ExchangeOnlineManagement'. Exiting..." -ForegroundColor Red
Exit
}
} else {
Write-Host "`nThe 'ExchangeOnlineManagement' Module is already installed" -ForegroundColor Green
}
}
# Function to connect to Exchange Online
function Connect_ExchangeSession {
try {
$getsessions = Get-PSSession | Select-Object -Property State, Name
$session = (@($getsessions) -like '@{State=Opened; Name=ExchangeOnlineInternalSession*').Count -gt 0
if (-not $session) {
Write-Host "Starting a new session..." -ForegroundColor Green
Connect-ExchangeOnline
} else {
Write-Host "Exchange Online session is already active." -ForegroundColor Green
}
} catch {
Write-Host "Failed to connect to Exchange Online. Error: $_" -ForegroundColor Red
Exit
}
}
# Function to gather mailbox add-in versions
function Get_MailboxAddInVersions {
$results = @()
$errors = @()
try {
$mailboxes = Get-Mailbox -ResultSize Unlimited |
Where-Object { $_.AccountDisabled -eq $false }
$total = $mailboxes.Count
$counter = 0
Write-Host "`nProcessing $total mailboxes..." -ForegroundColor Green
foreach ($mailbox in $mailboxes) {
$counter++
Write-Progress -Activity "Checking Add-in versions" `
-Status "$counter of $total : $($mailbox.UserPrincipalName)" `
-PercentComplete (($counter / $total) * 100)
# Use full UPN, not just the local-part
$appIdentity = "$($mailbox.UserPrincipalName)\$AddInID"
$appVersion = $null
$errorMsg = $null
try {
$appVersion = Get-App -Identity $appIdentity -ErrorAction Stop
} catch {
$errorMsg = $_.Exception.Message
$errors += [pscustomobject]@{
Mailbox = $mailbox.DisplayName
UPN = $mailbox.UserPrincipalName
Error = $errorMsg
}
}
$results += [pscustomobject]@{
Mailbox = $mailbox.DisplayName
UPN = $mailbox.UserPrincipalName # added for traceability
AppVersion = $appVersion.AppVersion
Enabled = $appVersion.Enabled
Deployment_Method = $appVersion.Type
Error = $errorMsg # visible in CSV
}
}
Write-Progress -Activity "Checking Add-in versions" -Completed
$results | Export-Csv -Path $CsvFilePath -NoTypeInformation
Write-Host "Output saved to: $CsvFilePath" -ForegroundColor Green
# Summary
$successCount = ($results | Where-Object { $null -ne $_.AppVersion }).Count
$emptyCount = ($results | Where-Object { $null -eq $_.AppVersion -and $null -eq $_.Error }).Count
$errorCount = $errors.Count
Write-Host "`n--- Summary ---" -ForegroundColor Cyan
Write-Host "Total mailboxes : $total"
Write-Host "With add-in : $successCount" -ForegroundColor Green
Write-Host "No add-in found : $emptyCount" -ForegroundColor Yellow
Write-Host "Errors : $errorCount" -ForegroundColor Red
if ($errors.Count -gt 0) {
$errorCsvPath = $CsvFilePath -replace '\.csv$', '_errors.csv'
$errors | Export-Csv -Path $errorCsvPath -NoTypeInformation
Write-Host "Error details : $errorCsvPath" -ForegroundColor Red
}
} catch {
Write-Host "Fatal error retrieving mailbox list. Error: $_" -ForegroundColor Red
}
}
# Function to end the session
function End_ExchangeSession {
try {
Disconnect-ExchangeOnline -Confirm:$false
Write-Host "Disconnected from Exchange Online." -ForegroundColor Green
} catch {
Write-Host "Error disconnecting session. Error: $_" -ForegroundColor Red
}
}
# Open output directory
function Open_OutputDir {
Start-Process $OutputPath
}
# Main execution
Ensure_ModuleInstalled
Connect_ExchangeSession
Get_MailboxAddInVersions
End_ExchangeSession
Open_OutputDir
if ($VerboseLogging) {
Stop-Transcript
}