forked from scriptrunner/ActionPacks
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathRemove-ExMailbox.ps1
58 lines (47 loc) · 1.87 KB
/
Remove-ExMailbox.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
#Requires -Version 4.0
<#
.SYNOPSIS
Connect to Microsoft Exchange Server and removes the mailbox
.DESCRIPTION
.NOTES
This PowerShell script was developed and optimized for ScriptRunner. The use of the scripts requires ScriptRunner.
The customer or user is authorized to copy the script from the repository and use them in ScriptRunner.
The terms of use for ScriptRunner do not apply to this script. In particular, AppSphere AG assumes no liability for the function,
the use and the consequences of the use of this freely available script.
PowerShell is a product of Microsoft Corporation. ScriptRunner is a product of AppSphere AG.
© AppSphere AG
.COMPONENT
ScriptRunner Version 4.x or higher
.LINK
https://github.com/scriptrunner/ActionPacks/tree/master/Exchange/MailBoxes
.Parameter MailboxId
Specifies the Alias, Display name, Distinguished name, SamAccountName, Guid or user principal name of the mailbox to remove
.Parameter Permanent
Specifies the mailbox is permanently removed from the database
#>
param(
[Parameter(Mandatory = $true)]
[string]$MailboxId,
[switch]$Permanent
)
#Clear
try{
$box = Get-Mailbox -Identity $MailboxId | Select-Object UserPrincipalName,DisplayName
if($null -ne $box){
Remove-Mailbox -Identity $box.UserPrincipalName -Permanent $Permanent.ToBool() -Confirm:$false -Force
if($SRXEnv) {
$SRXEnv.ResultMessage = "Mailbox $($box.DisplayName) removed"
}
else{
Write-Output "Mailbox $($box.DisplayName) removed"
}
}
else{
if($SRXEnv) {
$SRXEnv.ResultMessage = "Mailbox not found"
}
Throw "Mailbox not found"
}
}
finally{
}