Remove Mailbox
Applies To: System Center 2012 R2 Orchestrator, System Center 2012 SP1 - Orchestrator
You can use the Remove Mailbox activity to delete an existing mailbox and the Active Directory user that is associated with that mailbox, in an on-premise or online Exchange environment. For an environment such as Microsoft Office 365 online, the Remove Mailbox activity can be used to delete a mailbox.
The following tables list the required properties, optional properties, and published data for this activity.
Required properties for Remove Mailbox activity
Element |
Description |
Valid values |
Mailbox ID |
Identifies the mailbox that is to be removed. When Mailbox ID Type equals Identity, then the Mailbox ID property accepts the following value types: Alias. For example, JPhilips Canonical DN. For example, Atlanta.Corp.Contoso.Com/Users/JPhilips Display Name. For example, Jeff Philips Distinguished Name (DN). For example, N=JPhilips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com Domain\Account. For example, Atlanta\JPhilips GUID. For example, fb456636-fe7d-4d58-9d15-5af57d0354c2 Immutable ID. For example, fb456636-fe7d-4d58-9d15-5af57d0354c2@contoso.com Legacy Exchange DN. For example, /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhilips SMTP Address. For example, Jeff.Philips@contoso.com User Principal Name. For example, JPhilips@contoso.com Use only the Mailbox ID property to disconnect the mailbox from the user and to remove the user object from Active Directory. The mailbox object still exists. By default, this mailbox remains in the Exchange database for 30 days, and then is deleted. Use the Mailbox ID property in conjunction with the Permanent optional property to disconnect the mailbox from the user, remove the user object from Active Directory, and remove the mailbox object from the Exchange database. The mailbox object does not remain in the Exchange database as a disconnected mailbox. When Mailbox ID Type equals StoreMailboxIdentity, then the Mailbox ID property accepts the following value types: Mailbox display name GUID of the mailbox LegacyExchangeDN Use the Mailbox ID property in conjunction with the Database optional property when you have disconnected a mailbox from its associated user and want to remove the mailbox object from the Exchange database store. |
String |
Mailbox ID Type |
Specifies the type for the ID property. Note The StoreMailboxIdentity value is available only in an on-premises environment. |
Identity StoreMailboxIdentity |
Optional properties for Remove Mailbox activity
Element |
Description |
Valid values |
Arbitration |
Specifies that the mailbox for which the command is executed is an arbitration mailbox. Arbitration mailboxes are used for managing approval workflow. For example, an arbitration mailbox is used for handling moderated recipients and distribution group membership approval. Default is value True, when selected. Note This property is available only in an on-premises environment. |
True False |
Database |
Specifies the database that contains the mailbox object to be removed. This property accepts the following value types: GUID Database name Use in conjunction with the StoreMailboxIdentity type when you have disconnected a mailbox from its associated user and want to remove the mailbox object from the Exchange store. Note This property is available only in an on-premises environment. |
String |
Domain Controller |
Specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. Note This property is available only in an on-premises environment. |
String |
Ignore Default Scope |
Instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. The Ignore Default Scope property introduces the following restrictions: Domain Controller property cannot be used. The command uses an appropriate global catalog server automatically. Only the DN for the Identity property can be used. Other forms of identification, such as alias or GUID, are not accepted. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True False |
Ignore Legal Hold |
Ignores the legal hold status of the mail user and allows you to remove the mailbox that’s on legal hold. After a mailbox is removed, it cannot be included in a discovery search. Depending on the configured properties, removed mailboxes are either purged immediately or when the deleted mailbox retention period expires. Check with your organization’s policy or Human Resources department before you disable a mailbox that’s on legal hold. Default value is True, when selected. Note This property is not available in the Live@edu environment. |
True False |
Keep Windows Live ID (Live@edu only) |
Preserves the Windows Live ID that's associated with the deleted mailbox. This property applies to objects in the cloud-based service. It is not available for on-premises deployments. Default value is True, when selected. Note This property is available only in the Live@edu environment. |
True False |
Permanent |
Use this in conjunction with the Identity type to specify whether to disconnect the mailbox from the user, to remove the associated user object from Active Directory, and to remove the mailbox object from the Exchange database. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True False |
Remove Last Arbitration Mailbox Allowed |
Indicates whether it is allowed to remove the last Arbitration Mailbox. Default value is True, when selected. Note This property is available only in an on-premises environment. |
True or False |
Published data for Remove Mailbox activity
Element |
Description |
Valid values |
Exchange Environment |
Indicates the type of Exchange environment where this activity will be executed. |
String |
Exchange PowerShell Application |
Specifies the application name segment of the connection URI. |
String |
Exchange Server Host |
Connected Exchange Server. |
String |
Exchange Server Port |
Connected Exchange Server port. |
String |
Exchange User Name |
Username that is used to connect to Exchange Server. |
String |
Mailbox ID |
Identity of the mailbox or mail user. |
String |
Skip CA Check |
Indicates whether the client validates that the server certificate is signed by a trusted certification authority (CA) when connecting over Hypertext Transfer Protocol over Secure Socket Layer. |
String |
Skip CN Check |
Indicates whether the client validates that the certificate common name (CN) of the server matches the hostname of the server. |
String |
Skip Revocation Check |
Indicates whether the connection does not validate the revocation status of the server certificate. |
String |
Use SSL |
Indicates whether SSL encryption is used. |
String |