-
Notifications
You must be signed in to change notification settings - Fork 0
/
delete.UpdateMailboxAutoReplyConfiguration.ps1
323 lines (278 loc) · 12.9 KB
/
delete.UpdateMailboxAutoReplyConfiguration.ps1
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
#####################################################
# HelloID-Conn-Prov-Target-ExchangeOnline-Delete-Update-MailboxAutoReplyConfiguration
#
# Version: 2.0.0
#####################################################
# Initialize default values
$c = $configuration | ConvertFrom-Json
$p = $person | ConvertFrom-Json
# The accountReference object contains the Identification object provided in the account create call
$aRef = $accountReference | ConvertFrom-Json
$success = $false # Set to false at start, at the end, only when no error occurs it is set to true
$auditLogs = [System.Collections.Generic.List[PSCustomObject]]::new()
# Set TLS to accept TLS, TLS 1.1 and TLS 1.2
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls -bor [Net.SecurityProtocolType]::Tls11 -bor [Net.SecurityProtocolType]::Tls12
# Set debug logging
switch ($($c.isDebug)) {
$true { $VerbosePreference = "Continue" }
$false { $VerbosePreference = "SilentlyContinue" }
}
$InformationPreference = "Continue"
$WarningPreference = "Continue"
# Define configuration properties as required
$requiredConfigurationFields = @("AzureADOrganization", "AzureADTenantId", "AzureADAppId", "AzureADAppSecret")
# Used to connect to Exchange Online in an unattended scripting scenario using an App ID and App Secret to create an Access Token.
$AADOrganization = $c.AzureADOrganization
$AADTenantId = $c.AzureADTenantId
$AADAppID = $c.AzureADAppId
$AADAppSecret = $c.AzureADAppSecret
# PowerShell commands to import
$commands = @(
"Get-User"
, "Get-EXOMailbox"
, "Set-MailboxAutoReplyConfiguration"
)
# Change mapping here
# Remove externalId from manager name
$primaryManagerName = ($($p.PrimaryManager.DisplayName) -replace " \($($p.PrimaryManager.ExternalId)\)", '')
$primaryManagerEmail = $($p.PrimaryManager.Email)
$account = [PSCustomObject]@{
AutoReplyState = 'Enabled'
InternalMessage = "Dear colleague, thank you for your message. I am no longer employed at Enyoi. Your mail will be forwarded to $($primaryManagerName)"
ExternalMessage = "Dear Sir, Madam, Thank you for your email. I am no longer employed at Enyoi. Your mail is automatically forwarded to my colleague $($primaryManagerName) with mail address $($primaryManagerEmail)"
}
# Define account properties as required
$requiredAccountFields = @("AutoReplyState", "InternalMessage", "ExternalMessage")
#region functions
function Resolve-HTTPError {
[CmdletBinding()]
param (
[Parameter(Mandatory,
ValueFromPipeline
)]
[object]$ErrorObject
)
process {
$httpErrorObj = [PSCustomObject]@{
FullyQualifiedErrorId = $ErrorObject.FullyQualifiedErrorId
MyCommand = $ErrorObject.InvocationInfo.MyCommand
RequestUri = $ErrorObject.TargetObject.RequestUri
ScriptStackTrace = $ErrorObject.ScriptStackTrace
ErrorMessage = ""
}
if ($ErrorObject.Exception.GetType().FullName -eq "Microsoft.PowerShell.Commands.HttpResponseException") {
$httpErrorObj.ErrorMessage = $ErrorObject.ErrorDetails.Message
}
elseif ($ErrorObject.Exception.GetType().FullName -eq "System.Net.WebException") {
$httpErrorObj.ErrorMessage = [System.IO.StreamReader]::new($ErrorObject.Exception.Response.GetResponseStream()).ReadToEnd()
}
Write-Output $httpErrorObj
}
}
function Get-ErrorMessage {
[CmdletBinding()]
param (
[Parameter(Mandatory,
ValueFromPipeline
)]
[object]$ErrorObject
)
process {
$errorMessage = [PSCustomObject]@{
VerboseErrorMessage = $null
AuditErrorMessage = $null
}
if ( $($ErrorObject.Exception.GetType().FullName -eq "Microsoft.PowerShell.Commands.HttpResponseException") -or $($ErrorObject.Exception.GetType().FullName -eq "System.Net.WebException")) {
$httpErrorObject = Resolve-HTTPError -Error $ErrorObject
$errorMessage.VerboseErrorMessage = $httpErrorObject.ErrorMessage
$errorMessage.AuditErrorMessage = $httpErrorObject.ErrorMessage
}
# If error message empty, fall back on $ex.Exception.Message
if ([String]::IsNullOrEmpty($errorMessage.VerboseErrorMessage)) {
$errorMessage.VerboseErrorMessage = $ErrorObject.Exception.Message
}
if ([String]::IsNullOrEmpty($errorMessage.AuditErrorMessage)) {
$errorMessage.AuditErrorMessage = $ErrorObject.Exception.Message
}
Write-Output $errorMessage
}
}
#endregion functions
try {
# Check if required fields are available in configuration object
$incompleteConfiguration = $false
foreach ($requiredConfigurationField in $requiredConfigurationFields) {
if ($requiredConfigurationField -notin $c.PsObject.Properties.Name) {
$incompleteConfiguration = $true
Write-Warning "Required configuration object field [$requiredConfigurationField] is missing"
}
elseif ([String]::IsNullOrEmpty($c.$requiredConfigurationField)) {
$incompleteConfiguration = $true
Write-Warning "Required configuration object field [$requiredConfigurationField] has a null or empty value"
}
}
if ($incompleteConfiguration -eq $true) {
throw "Configuration object incomplete, cannot continue."
}
# Check if required fields are available in account object
$incompleteAccount = $false
foreach ($requiredAccountField in $requiredAccountFields) {
if ($requiredAccountField -notin $account.PsObject.Properties.Name) {
$incompleteAccount = $true
Write-Warning "Required account object field [$requiredAccountField] is missing"
}
elseif ([String]::IsNullOrEmpty($account.$requiredAccountField)) {
$incompleteAccount = $true
Write-Warning "Required account object field [$requiredAccountField] has a null or empty value"
}
}
if ($incompleteAccount -eq $true) {
throw "Account object incomplete, cannot continue."
}
try {
# Import module
$moduleName = "ExchangeOnlineManagement"
# If module is imported say that and do nothing
if (Get-Module -Verbose:$false | Where-Object { $_.Name -eq $ModuleName }) {
Write-Verbose "Module [$ModuleName] is already imported."
}
else {
# If module is not imported, but available on disk then import
if (Get-Module -ListAvailable -Verbose:$false | Where-Object { $_.Name -eq $ModuleName }) {
$module = Import-Module $ModuleName -Cmdlet $commands -Verbose:$false
Write-Verbose "Imported module [$ModuleName]"
}
else {
# If the module is not imported, not available and not in the online gallery then abort
throw "Module [$ModuleName] is not available. Please install the module using: Install-Module -Name [$ModuleName] -Force"
}
}
}
catch {
$ex = $PSItem
$errorMessage = Get-ErrorMessage -ErrorObject $ex
Write-Verbose "Error at Line [$($ex.InvocationInfo.ScriptLineNumber)]: $($ex.InvocationInfo.Line). Error: $($errorMessage.VerboseErrorMessage)"
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "Error importing module [$ModuleName]. Error Message: $($errorMessage.AuditErrorMessage)"
IsError = $True
})
# Skip further actions, as this is a critical error
continue
}
# Connect to Exchange
try {
# Create access token
Write-Verbose "Creating Access Token"
$baseUri = "https://login.microsoftonline.com/"
$authUri = $baseUri + "$AADTenantId/oauth2/token"
$body = @{
grant_type = "client_credentials"
client_id = "$AADAppID"
client_secret = "$AADAppSecret"
resource = "https://outlook.office365.com"
}
$Response = Invoke-RestMethod -Method POST -Uri $authUri -Body $body -ContentType "application/x-www-form-urlencoded" -UseBasicParsing:$true
$accessToken = $Response.access_token
# Connect to Exchange Online in an unattended scripting scenario using an access token.
Write-Verbose "Connecting to Exchange Online"
$exchangeSessionParams = @{
Organization = $AADOrganization
AppID = $AADAppID
AccessToken = $accessToken
CommandName = $commands
ShowBanner = $false
ShowProgress = $false
TrackPerformance = $false
ErrorAction = "Stop"
}
$exchangeSession = Connect-ExchangeOnline @exchangeSessionParams
Write-Information "Successfully connected to Exchange Online"
}
catch {
$ex = $PSItem
$errorMessage = Get-ErrorMessage -ErrorObject $ex
Write-Verbose "Error at Line [$($ex.InvocationInfo.ScriptLineNumber)]: $($ex.InvocationInfo.Line). Error: $($errorMessage.VerboseErrorMessage)"
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "Error connecting to Exchange Online. Error Message: $($errorMessage.AuditErrorMessage)"
IsError = $True
})
# Skip further actions, as this is a critical error
continue
}
# Get Exchange Online Mailbox
try {
Write-Verbose "Querying EXO mailbox [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
$mailbox = Get-EXOMailbox -Identity $aRef.Guid -ErrorAction Stop
if (($mailbox | Measure-Object).Count -eq 0) {
throw "Could not find a EXO mailbox [$($aRef.UserPrincipalName) ($($aRef.Guid))]"
}
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "Successfully queried EXO mailbox [$($aRef.userPrincipalName) ($($aRef.Guid))]"
IsError = $false
})
}
catch {
$ex = $PSItem
$errorMessage = Get-ErrorMessage -ErrorObject $ex
Write-Verbose "Error at Line [$($ex.InvocationInfo.ScriptLineNumber)]: $($ex.InvocationInfo.Line). Error: $($errorMessage.VerboseErrorMessage)"
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "Error querying EXO mailbox [$($aRef.UserPrincipalName) ($($aRef.Guid))]. Error Message: $($errorMessage.AuditErrorMessage)"
IsError = $True
})
}
# Update Mailbox AutoReply Configuration
try {
Write-Verbose "Updating autoreply configuration for mailbox [$($aRef.userPrincipalName) ($($aRef.Guid))]: $($mailboxSplatParams | ConvertTo-Json)"
$mailboxSplatParams = @{
Identity = $($aRef.Guid)
AutoReplyState = $($account.AutoReplyState)
InternalMessage = $($account.InternalMessage)
ExternalMessage = $($account.ExternalMessage)
}
if ($dryRun -eq $false) {
$updateMailbox = Set-MailboxAutoReplyConfiguration @mailboxSplatParams -ErrorAction Stop
$auditLogs.Add([PSCustomObject]@{
Action = "CreateAccount"
Message = "Successfully updated autoreply configuration for mailbox [$($aRef.userPrincipalName) ($($aRef.Guid))]: $($mailboxSplatParams | ConvertTo-Json)"
IsError = $false
})
}
else {
Write-Warning "DryRun: would update autoreply configuration for mailbox [$($aRef.userPrincipalName) ($($aRef.Guid))]: $($mailboxSplatParams | ConvertTo-Json)"
}
}
catch {
$ex = $PSItem
$errorMessage = Get-ErrorMessage -ErrorObject $ex
Write-Verbose "Error at Line [$($ex.InvocationInfo.ScriptLineNumber)]: $($ex.InvocationInfo.Line). Error: $($errorMessage.VerboseErrorMessage)"
$auditLogs.Add([PSCustomObject]@{
# Action = "" # Optional
Message = "Error updating autoreply configuration for mailbox [$($aRef.userPrincipalName) ($($aRef.Guid))]: $($mailboxSplatParams | ConvertTo-Json). Error Message: $($errorMessage.AuditErrorMessage)"
IsError = $True
})
}
}
finally {
# Check if auditLogs contains errors, if no errors are found, set success to true
if (-NOT($auditLogs.IsError -contains $true)) {
$success = $true
}
# Send results
$result = [PSCustomObject]@{
Success = $success
AccountReference = $aRef
AuditLogs = $auditLogs
Account = $account
# Optionally return data for use in other systems
ExportData = [PSCustomObject]@{
DisplayName = $mailbox.DisplayName
UserPrincipalName = $mailbox.UserPrincipalName
Guid = $mailbox.Guid
}
}
Write-Output ($result | ConvertTo-Json -Depth 10)
}