Export (0) Print
Expand All
Expand Minimize

Enable-Mailbox

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-21

This cmdlet is available in on-premises Exchange Server 2013 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

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

For information about the parameter sets in the Syntax section below, see Syntax.

Enable-Mailbox [-AccountDisabled <$true | $false>] [-AddOnSKUCapability <MultiValuedProperty>] [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] [-BypassModerationCheck <SwitchParameter>] [-Database <DatabaseIdParameter>] [-MailboxPlan <MailboxPlanIdParameter>] [-SKUAssigned <$true | $false>] [-SKUCapability <None | BPOS_S_Deskless | BPOS_S_Standard | BPOS_S_Enterprise | BPOS_S_Archive | BPOS_L_Standard | BPOS_B_Standard | BPOS_B_CustomDomain | BPOS_S_MidSize | BPOS_S_ArchiveAddOn | BPOS_S_EopStandardAddOn | BPOS_S_EopPremiumAddOn | BPOS_Unmanaged | TOU_Signed | FederatedUser | Partner_Managed | MasteredOnPremise | ResourceMailbox | ExcludedFromBackSync | UMFeatureRestricted | RichCoexistence | OrganizationCapabilityUMGrammar | OrganizationCapabilityUMDataStorage | OrganizationCapabilityOABGen | OrganizationCapabilityGMGen | OrganizationCapabilityClientExtensions | BEVDirLockdown | OrganizationCapabilityUMGrammarReady | OrganizationCapabilityMailRouting | OrganizationCapabilityManagement | OrganizationCapabilityTenantUpgrade | OrganizationCapabilityScaleOut | OrganizationCapabilityMessageTracking | OrganizationCapabilityPstProvider | OrganizationCapabilitySuiteServiceStorage>] [-TargetAllMDBs <SwitchParameter>] [-UsageLocation <CountryInfo>] <COMMON PARAMETERS>
Enable-Mailbox -Room <SwitchParameter> [-AccountDisabled <$true | $false>] [-BypassModerationCheck <SwitchParameter>] [-Database <DatabaseIdParameter>] [-TargetAllMDBs <SwitchParameter>] <COMMON PARAMETERS>
Enable-Mailbox [-AccountDisabled <$true | $false>] [-AddOnSKUCapability <MultiValuedProperty>] [-BypassModerationCheck <SwitchParameter>] [-Database <DatabaseIdParameter>] [-MailboxPlan <MailboxPlanIdParameter>] [-SKUAssigned <$true | $false>] [-SKUCapability <None | BPOS_S_Deskless | BPOS_S_Standard | BPOS_S_Enterprise | BPOS_S_Archive | BPOS_L_Standard | BPOS_B_Standard | BPOS_B_CustomDomain | BPOS_S_MidSize | BPOS_S_ArchiveAddOn | BPOS_S_EopStandardAddOn | BPOS_S_EopPremiumAddOn | BPOS_Unmanaged | TOU_Signed | FederatedUser | Partner_Managed | MasteredOnPremise | ResourceMailbox | ExcludedFromBackSync | UMFeatureRestricted | RichCoexistence | OrganizationCapabilityUMGrammar | OrganizationCapabilityUMDataStorage | OrganizationCapabilityOABGen | OrganizationCapabilityGMGen | OrganizationCapabilityClientExtensions | BEVDirLockdown | OrganizationCapabilityUMGrammarReady | OrganizationCapabilityMailRouting | OrganizationCapabilityManagement | OrganizationCapabilityTenantUpgrade | OrganizationCapabilityScaleOut | OrganizationCapabilityMessageTracking | OrganizationCapabilityPstProvider | OrganizationCapabilitySuiteServiceStorage>] [-TargetAllMDBs <SwitchParameter>] [-UsageLocation <CountryInfo>] <COMMON PARAMETERS>
Enable-Mailbox -Shared <SwitchParameter> [-AccountDisabled <$true | $false>] [-BypassModerationCheck <SwitchParameter>] [-Database <DatabaseIdParameter>] [-TargetAllMDBs <SwitchParameter>] <COMMON PARAMETERS>
Enable-Mailbox -Arbitration <SwitchParameter> [-Database <DatabaseIdParameter>] [-TargetAllMDBs <SwitchParameter>] <COMMON PARAMETERS>
Enable-Mailbox -PublicFolder <SwitchParameter> [-Database <DatabaseIdParameter>] [-HoldForMigration <SwitchParameter>] <COMMON PARAMETERS>
Enable-Mailbox -Discovery <SwitchParameter> [-Database <DatabaseIdParameter>] [-TargetAllMDBs <SwitchParameter>] <COMMON PARAMETERS>
Enable-Mailbox -Equipment <SwitchParameter> [-AccountDisabled <$true | $false>] [-BypassModerationCheck <SwitchParameter>] [-Database <DatabaseIdParameter>] [-TargetAllMDBs <SwitchParameter>] <COMMON PARAMETERS>
Enable-Mailbox -LinkedDomainController <String> -LinkedMasterAccount <UserIdParameter> [-Database <DatabaseIdParameter>] [-LinkedCredential <PSCredential>] [-TargetAllMDBs <SwitchParameter>] <COMMON PARAMETERS>
Enable-Mailbox [-Archive <SwitchParameter>] [-ArchiveDatabase <DatabaseIdParameter>] [-ArchiveGuid <Guid>] [-ArchiveName <MultiValuedProperty>] [-BypassModerationCheck <SwitchParameter>] <COMMON PARAMETERS>
Enable-Mailbox -ArchiveDomain <SmtpDomain> [-RemoteArchive <SwitchParameter>] <COMMON PARAMETERS>
COMMON PARAMETERS: -Identity <UserIdParameter> [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-Alias <String>] [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-IncludeSoftDeletedObjects <SwitchParameter>] [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] [-ManagedFolderMailboxPolicyAllowed <SwitchParameter>] [-OverrideRecipientQuotas <SwitchParameter>] [-PrimarySmtpAddress <SmtpAddress>] [-RetentionPolicy <MailboxPolicyIdParameter>] [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] [-WhatIf [<SwitchParameter>]]

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

Enable-Mailbox -Identity Contoso\Ayla -Database Database01

This example creates a remote archive for the existing user Ayla. 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"

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 email 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 Recipients permissions topic.

 

Parameter Required Type Description

Arbitration

Required

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2013.

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

This parameter is available only in on-premises Exchange 2013.

The ArchiveDomain parameter specifies the cloud-based domain on which the archive associated with this mailbox exists. For example, if the SMTP email 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 In-Place eDiscovery.

Equipment

Required

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2013.

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.

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)

LinkedDomainController

Required

System.String

This parameter is available only in on-premises Exchange 2013.

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

This parameter is available only in on-premises Exchange 2013.

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

PublicFolder

Required

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2013.

The PublicFolder parameter specifies that the mailbox to enable is a public folder mailbox. Public folder mailboxes are specially designed mailboxes to store the hierarchy and content of public folders. This parameter is required if you're enabling a public folder mailbox.

Room

Required

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2013.

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

This parameter is available only in on-premises Exchange 2013.

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

This parameter is available only in on-premises Exchange 2013.

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.

AddOnSKUCapability

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is reserved for internal Microsoft use.

AddressBookPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.AddressBookMailboxPolicyIdParameter

This parameter is available only in on-premises Exchange 2013.

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

Alias

Optional

System.String

This parameter is available only in on-premises Exchange 2013.

The Alias parameter specifies the email 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

This parameter is available only in on-premises Exchange 2013.

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

This parameter is available only in on-premises Exchange 2013.

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 Administration Center.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2013.

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.

HoldForMigration

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2013.

The HoldForMigration parameter specifies whether to prevent any client or user, except the Microsoft Exchange Mailbox Replication service (MRS) process, from logging into a public folder mailbox. You must use this parameter when you create the first public folder, which is called the hierarchy mailbox, in your organization.

IncludeSoftDeletedObjects

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

LinkedCredential

Optional

System.Management.Automation.PSCredential

This parameter is available only in on-premises Exchange 2013.

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 reserved for internal Microsoft use.

ManagedFolderMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

This parameter is available only in on-premises Exchange 2013.

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

This parameter is available only in on-premises Exchange 2013.

The ManagedFolderMailboxPolicyAllowed parameter specifies whether to bypass the warning that messaging records management (MRM) features aren't supported for email 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.

OverrideRecipientQuotas

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

This parameter is available only in on-premises Exchange 2013.

The PrimarySmtpAddress parameter specifies the primary SMTP address for the mailbox. By default, the primary SMTP address is generated based on the default email 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 email addresses of this mailbox aren't automatically updated based on email address policies.

RemoteArchive

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2013.

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

This parameter is available only in on-premises Exchange 2013.

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.

TargetAllMDBs

Optional

System.Management.Automation.SwitchParameter

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft