Export (0) Print
Expand All

Remove-Mailbox

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

Use the Remove-Mailbox cmdlet to delete the user account associated with a particular mailbox from Active Directory and to process the associated, disconnected mailbox as directed by the specified parameters.


Remove-Mailbox -Identity <MailboxIdParameter> [-Arbitration <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-KeepWindowsLiveID <SwitchParameter>] [-Permanent <$true | $false>] [-RemoveLastArbitrationMailboxAllowed <SwitchParameter>] [-WhatIf [<SwitchParameter>]]


Remove-Mailbox -Database <DatabaseIdParameter> -StoreMailboxIdentity <StoreMailboxIdParameter> [-Arbitration <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-RemoveLastArbitrationMailboxAllowed <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Parameter Required Type Description

Database

Required

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The Database parameter specifies the database that contains the mailbox object. You can use one of the following values:

  • GUID
  • Database name
  • Server name\database name

If you don't specify the server name, the cmdlet searches for the database on the local server.

This parameter must be used in conjunction with the StoreMailboxIdentity parameter. The Database parameter can't be used with the Identity parameter. If you've disconnected a mailbox from its associated user and want to remove the mailbox object from the Exchange store, use the Database and StoreMailboxIdentity parameters.

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter identifies the mailbox object that you want to remove. You can use one of the following values:

  • ADObjectID
  • Distinguished name (DN)
  • Legacy DN
  • GUID
  • Domain\Account name
  • User principal name (UPN)
  • E-mail address
  • Alias

The Identity parameter can't be used with the Database parameter.

StoreMailboxIdentity

Required

Microsoft.Exchange.Configuration.Tasks.StoreMailboxIdParameter

The StoreMailboxIdentity parameter specifies the mailbox object to remove. The StoreMailboxIdentity parameter is used in conjunction with the Database parameter to remove the mailbox object from the Exchange database. If you've disconnected a mailbox from its associated user and want to remove the mailbox object from the Exchange store, use the Database and StoreMailboxIdentity parameters.

Arbitration

Optional

System.Management.Automation.SwitchParameter

The Arbitration parameter specifies that the mailbox for which you are executing the command 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.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

The IgnoreDefaultScope parameter 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. Using the IgnoreDefaultScope parameter introduces the following restrictions:

  • You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.
  • You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted.

KeepWindowsLiveID

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in the Outlook Live service.

The KeepWindowsLiveID parameter preserves the Windows Live ID that's associated with the deleted mailbox.

Permanent

Optional

System.Boolean

The Permanent parameter, when used in conjunction with the Identity parameter, specifies whether to disconnect the mailbox from the user, remove the associated user object from Active Directory, and remove the mailbox object from the Exchange database. The two possible values for this parameter are $true or $false. The default value is $false.

RemoveLastArbitrationMailboxAllowed

Optional

System.Management.Automation.SwitchParameter

The RemoveLastArbitrationMailboxAllowed switch specifies whether the mailbox that you're trying to use is the last arbitration mailbox in the organization.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Use the Identity parameter alone to disconnect the mailbox from the user and 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 Identity and Permanent parameters 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 doesn't remain in the Exchange database as a disconnected mailbox.

Use the Database and StoreMailboxIdentity parameters to remove a mailbox object from the Exchange database. In this case, the mailbox object has already been disconnected from the user. For example, if you run the Disable-Mailbox cmdlet, the Exchange mailbox object still exists, but is disconnected from the Active Directory user object. You can use the Database and StoreMailboxIdentity parameters to remove this disconnected mailbox object.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Recipient Provisioning Permissions" section in the Mailbox Permissions topic.

Error Description

 

 

Exceptions Description

 

 

This example disconnects the user John Peoples' (john) mailbox from the user account and removes the mailbox object from Active Directory. The mailbox remains in the Exchange database for the deleted mailbox retention period configured for the mailbox database.

Remove-Mailbox -Identity contoso\john

This example disconnects the user John Peoples' (john) mailbox from the user account, removes the mailbox object from Active Directory, and removes the mailbox from the Exchange database.

Remove-Mailbox -Identity contoso\john -Permanent $true

This example removes John Peoples' mailbox from the Exchange database, assuming the mailbox has already been disconnected from the user. The example shows how to use the Get-Mailbox cmdlet to retrieve the mailbox GUID value using the display name of the disconnected mailbox. This value is needed for the StoreMailboxIdentity parameter of the Remove-Mailbox cmdlet.

$Temp = Get-Mailbox | Where {$_.DisplayName -eq 'John Peoples'}
Remove-Mailbox -Database Server01\Database01 -StoreMailboxIdentity $Temp.MailboxGuid
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft