Export (0) Print
Expand All
Related Help Topics
Loading
No resources found.
Related Blog Articles
Loading
No resources found.
Expand Minimize

Enable-Mailbox

 

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-11-16

Use the Enable-Mailbox cmdlet to mailbox-enable an existing user or Active Directory InetOrgPerson object.

enable-Mailbox -Identity <UserIdParameter> [-AccountDisabled <$true | $false>] [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] [-Alias <String>] [-BypassModerationCheck <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-Database <DatabaseIdParameter>] [-DisplayName <String>] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-MailboxPlan <MailboxPlanIdParameter>] [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] [-ManagedFolderMailboxPolicyAllowed <SwitchParameter>] [-PrimarySmtpAddress <SmtpAddress>] [-RetentionPolicy <MailboxPolicyIdParameter>] [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] [-SKUAssigned <$true | $false>] [-SKUCapability <None | BPOS_S_Deskless | BPOS_S_Standard | BPOS_S_Enterprise | BPOS_S_Archive | BPOS_L_Standard | BPOS_B_Standard | TOU_Signed | FederatedUser | Partner_Managed | MasteredOnPremise | ResourceMailbox | ExcludedFromBackSync | UMFeatureRestricted | RichCoexistence>] [-UsageLocation <CountryInfo>] [-WhatIf [<SwitchParameter>]]
enable-Mailbox -Identity <UserIdParameter> -Shared <SwitchParameter> [-AccountDisabled <$true | $false>] [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-Alias <String>] [-BypassModerationCheck <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-Database <DatabaseIdParameter>] [-DisplayName <String>] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] [-ManagedFolderMailboxPolicyAllowed <SwitchParameter>] [-PrimarySmtpAddress <SmtpAddress>] [-RetentionPolicy <MailboxPolicyIdParameter>] [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] [-WhatIf [<SwitchParameter>]]
enable-Mailbox -Identity <UserIdParameter> -Discovery <SwitchParameter> [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-Alias <String>] [-Confirm [<SwitchParameter>]] [-Database <DatabaseIdParameter>] [-DisplayName <String>] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] [-ManagedFolderMailboxPolicyAllowed <SwitchParameter>] [-PrimarySmtpAddress <SmtpAddress>] [-RetentionPolicy <MailboxPolicyIdParameter>] [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] [-WhatIf [<SwitchParameter>]]
enable-Mailbox -Identity <UserIdParameter> -Equipment <SwitchParameter> [-AccountDisabled <$true | $false>] [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-Alias <String>] [-BypassModerationCheck <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-Database <DatabaseIdParameter>] [-DisplayName <String>] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] [-ManagedFolderMailboxPolicyAllowed <SwitchParameter>] [-PrimarySmtpAddress <SmtpAddress>] [-RetentionPolicy <MailboxPolicyIdParameter>] [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] [-WhatIf [<SwitchParameter>]]
enable-Mailbox -Identity <UserIdParameter> -LinkedDomainController <String> -LinkedMasterAccount <UserIdParameter> [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-Alias <String>] [-Confirm [<SwitchParameter>]] [-Database <DatabaseIdParameter>] [-DisplayName <String>] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-LinkedCredential <PSCredential>] [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] [-ManagedFolderMailboxPolicyAllowed <SwitchParameter>] [-PrimarySmtpAddress <SmtpAddress>] [-RetentionPolicy <MailboxPolicyIdParameter>] [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] [-WhatIf [<SwitchParameter>]]
enable-Mailbox -Identity <UserIdParameter> [-AccountDisabled <$true | $false>] [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-Alias <String>] [-BypassModerationCheck <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-Database <DatabaseIdParameter>] [-DisplayName <String>] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-MailboxPlan <MailboxPlanIdParameter>] [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] [-ManagedFolderMailboxPolicyAllowed <SwitchParameter>] [-PrimarySmtpAddress <SmtpAddress>] [-RetentionPolicy <MailboxPolicyIdParameter>] [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] [-SKUAssigned <$true | $false>] [-SKUCapability <None | BPOS_S_Deskless | BPOS_S_Standard | BPOS_S_Enterprise | BPOS_S_Archive | BPOS_L_Standard | BPOS_B_Standard | TOU_Signed | FederatedUser | Partner_Managed | MasteredOnPremise | ResourceMailbox | ExcludedFromBackSync | UMFeatureRestricted | RichCoexistence>] [-UsageLocation <CountryInfo>] [-WhatIf [<SwitchParameter>]]
enable-Mailbox -Identity <UserIdParameter> -Arbitration <SwitchParameter> [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-Alias <String>] [-Confirm [<SwitchParameter>]] [-Database <DatabaseIdParameter>] [-DisplayName <String>] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] [-ManagedFolderMailboxPolicyAllowed <SwitchParameter>] [-PrimarySmtpAddress <SmtpAddress>] [-RetentionPolicy <MailboxPolicyIdParameter>] [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] [-WhatIf [<SwitchParameter>]]
enable-Mailbox -Identity <UserIdParameter> -Room <SwitchParameter> [-AccountDisabled <$true | $false>] [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-Alias <String>] [-BypassModerationCheck <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-Database <DatabaseIdParameter>] [-DisplayName <String>] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] [-ManagedFolderMailboxPolicyAllowed <SwitchParameter>] [-PrimarySmtpAddress <SmtpAddress>] [-RetentionPolicy <MailboxPolicyIdParameter>] [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] [-WhatIf [<SwitchParameter>]]
enable-Mailbox -Identity <UserIdParameter> [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-Alias <String>] [-Archive <SwitchParameter>] [-ArchiveDatabase <DatabaseIdParameter>] [-ArchiveGuid <Guid>] [-ArchiveName <MultiValuedProperty>] [-BypassModerationCheck <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] [-ManagedFolderMailboxPolicyAllowed <SwitchParameter>] [-PrimarySmtpAddress <SmtpAddress>] [-RetentionPolicy <MailboxPolicyIdParameter>] [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] [-WhatIf [<SwitchParameter>]]
enable-Mailbox -Identity <UserIdParameter> -ArchiveDomain <SmtpDomain> [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-Alias <String>] [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] [-ManagedFolderMailboxPolicyAllowed <SwitchParameter>] [-PrimarySmtpAddress <SmtpAddress>] [-RemoteArchive <SwitchParameter>] [-RetentionPolicy <MailboxPolicyIdParameter>] [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] [-WhatIf [<SwitchParameter>]]

Mailbox-enabling an existing user or InetOrgPerson object creates additional mailbox attributes on the user object in Active Directory. When the user logs on to the mailbox or receives e-mail messages, a mailbox object in the Exchange database is created.

Use the Identity parameter to specify the user or InetOrgPerson object for whom the mailbox is enabled. Use the Database parameter to specify the Exchange database that contains the mailbox.

importantImportant:
When mailbox-enabling an existing user, if an alias isn't specified, Exchange uses the name and converts all non-ASCII characters to question mark (?) characters. In some languages that use nonstandard character sets, the user account may have a non-ASCII value for the name. In this case, when you mailbox-enable the user, the alias is changed to all question mark characters. To avoid this, confirm that the user account has an ASCII name before you create the new mailbox, or make sure you specify a value for the alias.

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.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UserIdParameter

The Identity parameter specifies the user or InetOrgPerson object that you want to mailbox-enable. You can use one of the following values:

  • GUID
  • Distinguished name (DN)
  • Display name
  • Domain\Account
  • User principal name (UPN)

Arbitration

Required

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.

ArchiveDomain

Required

Microsoft.Exchange.Data.SmtpDomain

The ArchiveDomain parameter specifies the cloud-based domain on which the archive associated with this mailbox exists. For example, if the SMTP e-mail address of the user is tony@contoso.com, the SMTP domain could be archive.contoso.com.

noteNote:
Only use this parameter if the archive is hosted in a cloud-based service.

Discovery

Required

System.Management.Automation.SwitchParameter

The Discovery parameter specifies that this mailbox is a Discovery mailbox. Discovery mailboxes are created as target mailboxes for Discovery searches. You don't have to include a value with this parameter.

After being created or enabled, a Discovery mailbox can't be converted to another type of mailbox.

For more information, see Understanding Multi-Mailbox Search.

Equipment

Required

System.Management.Automation.SwitchParameter

The Equipment parameter specifies that the type of resource is equipment, if this mailbox is a resource mailbox. This parameter is required only if you're enabling a resource mailbox.

LinkedDomainController

Required

System.String

The LinkedDomainController parameter specifies the domain controller in the forest where the user account resides. The domain controller in this forest is used to get security information for the account specified by the LinkedMasterAccount parameter. This parameter is required only if you're creating a linked mailbox. Use the fully qualified domain name (FQDN) of the domain controller you want to use as the value for this parameter.

LinkedMasterAccount

Required

Microsoft.Exchange.Configuration.Tasks.UserIdParameter

The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides. The master account is the account to link the mailbox to. The master account grants access to the mailbox. This parameter is required only if you're creating a linked mailbox. You can use one of the following values:

  • GUID
  • DN
  • Domain\Account
  • UPN
  • LegacyExchangeDN
  • SmtpAddress
  • Alias

Room

Required

System.Management.Automation.SwitchParameter

The Room parameter specifies that the type of resource is a room, if this mailbox is a resource mailbox. This parameter is required only if you're enabling a resource mailbox.

You don't have to specify a value with this parameter.

Shared

Required

System.Management.Automation.SwitchParameter

The Shared parameter specifies that you're creating a shared mailbox. A shared mailbox is a mailbox to which multiple users can log on. This mailbox isn't associated with any of the users that can log on. It's associated with a disabled user account.

This parameter is required only if you're creating a shared mailbox.

AccountDisabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

ActiveSyncMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The ActiveSyncMailboxPolicy parameter specifies the mailbox policy to enable for the mailbox that you create. If you don't specify this parameter, the default mailbox policy is used.

AddressBookPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.AddressBookMailboxPolicyIdParameter

The AddressBookPolicy parameter specifies the address book policy to apply to this mailbox. For more information about address book policies, see Understanding Address Book Policies.

Alias

Optional

System.String

The Alias parameter specifies the e-mail alias of the mailbox that you're enabling.

The alias can be a combination of characters separated by a period with no intervening spaces. Don't use special characters in the alias.

Archive

Optional

System.Management.Automation.SwitchParameter

The Archive parameter specifies that when this mailbox is enabled, an archive will be created.

ArchiveDatabase

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The ArchiveDatabase parameter specifies the Exchange database that contains the archive associated with this mailbox. You can use the following values:

  • GUID of the database
  • Database name

ArchiveGuid

Optional

System.Guid

This parameter is reserved for internal Microsoft use.

ArchiveName

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Microsoft Office Outlook Web App and Microsoft Outlook. The default name is Online Archive - <Mailbox User's Display Name>.

BypassModerationCheck

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

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.

Database

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The Database parameter specifies which Exchange database contains the new mailbox. You can use one of the following values:

  • GUID of the database
  • Database name

DisplayName

Optional

System.String

The DisplayName parameter specifies the display name for the mailbox. The DisplayName is the name that appears in the Exchange Management Console under Recipient Configuration.

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.

Force

Optional

System.Management.Automation.SwitchParameter

The Force parameter specifies whether to suppress warning or confirmation messages. This parameter can be used when the task is run programmatically and prompting for administrative input is inappropriate. If the Force parameter isn't provided in the command, administrative input is prompted. If the Force parameter is provided in the command, but the value is omitted, its default value is $true.

LinkedCredential

Optional

System.Management.Automation.PSCredential

The LinkedCredential parameter specifies credentials to use to access the domain controller specified by the LinkedDomainController parameter. This parameter is optional, even if you're enabling a linked mailbox.

MailboxPlan

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPlanIdParameter

This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support.

The MailboxPlan parameter specifies the mailbox plan to associate with this mailbox. A mailbox plan specifies the permissions and features available to a mailbox user. The mailbox plan name you provide must be included in the service plan of the organization in which this mailbox resides. To learn more, see Understanding Service Plans and Mailbox Plans.

To use or change the MailboxPlan parameter, tenant administrators must have the ChangeMailboxPlanAssignmentPermissions feature assigned through their service plan.

ManagedFolderMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The ManagedFolderMailboxPolicy parameter specifies the managed folder mailbox policy to enable for the mailbox that you create. If you don't specify this parameter, the default managed folder mailbox policy is used.

ManagedFolderMailboxPolicyAllowed

Optional

System.Management.Automation.SwitchParameter

The ManagedFolderMailboxPolicyAllowed parameter specifies whether to bypass the warning that messaging records management (MRM) features aren't supported for e-mail clients using versions of Outlook earlier than Office Outlook 2007. When a managed folder mailbox policy is assigned to a mailbox using the ManagedFolderMailboxPolicy parameter, the warning appears by default unless the ManagedFolderMailboxPolicyAllowed parameter is used.

noteNote:
Outlook 2003 Service Pack 3 clients are supported but are provided limited functionality for MRM.

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The PrimarySmtpAddress parameter specifies the primary SMTP address for the mailbox. By default, the primary SMTP address is generated based on the default e-mail address policy. If you specify a primary SMTP address by using this parameter, the command sets the EmailAddressPolicyEnabled attribute of the mailbox to $false, and the e-mail addresses of this mailbox aren't automatically updated based on e-mail address policies.

RemoteArchive

Optional

System.Management.Automation.SwitchParameter

The RemoteArchive parameter specifies that when the mailbox is enabled, a remote archive for this mailbox will be created. A remote archive exists in a cloud-based service. You don't have to specify a value with this parameter. You can't use the Archive parameter in conjunction with this parameter.

RetentionPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The RetentionPolicy parameter specifies the name of a retention policy that you want applied to this mailbox. Retention policies consist of tags that are applied to mailbox folders and mail items to determine the period of time that the items should be retained.

RoleAssignmentPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The RoleAssignmentPolicy parameter specifies the management role assignment policy to assign to the mailbox when it's created or enabled. If you don't include this parameter when you create or enable a mailbox, the default assignment policy is used. If the assignment policy name contains spaces, enclose the name in quotation marks ("). If you don't want to assign an assignment policy when a mailbox is created or enabled, specify a value of $null. For more information about assignment policies, see Understanding Management Role Assignment Policies.

SKUAssigned

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

SKUCapability

Optional

Microsoft.Exchange.Data.Directory.Capability

This parameter is reserved for internal Microsoft use.

UsageLocation

Optional

Microsoft.Exchange.Data.Directory.CountryInfo

This parameter is reserved for internal Microsoft use.

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.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

This example creates a mailbox for the existing user Ayla Kol. The mailbox is created in Database01.

Enable-Mailbox -Identity Contoso\Ayla -Database Database01

This example creates a remote archive for the existing user Ayla Kol. The archive is created with the following settings:

  • The archive database has the GUID 82025f12-8000-4d5e-8059-c052f9355125.
  • The archive domain is archive.contoso.com.
Enable-Mailbox -Identity ayla@contoso.com -RemoteArchive -ArchiveDatabase "82025f12-8000-4d5e-8059-c052f9355125" -ArchiveDomain "archive.contoso.com"
 © 2010 Microsoft Corporation. All rights reserved.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft