Any suggestions? Export (0) Print
Expand All

New-Mailbox

 

Applies to: Exchange Online, Exchange Server 2016

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

Use the New-Mailbox cmdlet to create mailboxes and user accounts at the same time.

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

New-Mailbox -Password <SecureString> -UserPrincipalName <String> [-ArbitrationMailbox <MailboxIdParameter>] [-InactiveMailbox <MailboxIdParameter>] [-MailboxPlan <MailboxPlanIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-RemovedMailbox <RemovedMailboxIdParameter>] [-SendModerationNotifications <Never | Internal | Always>] <COMMON PARAMETERS>

New-Mailbox -Room <SwitchParameter> [-ArbitrationMailbox <MailboxIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Office <String>] [-Password <SecureString>] [-Phone <String>] [-ResourceCapacity <Int32>] [-SendModerationNotifications <Never | Internal | Always>] [-UserPrincipalName <String>] <COMMON PARAMETERS>

New-Mailbox -LinkedDomainController <String> -LinkedMasterAccount <UserIdParameter> -LinkedRoom <SwitchParameter> [-ArbitrationMailbox <MailboxIdParameter>] [-LinkedCredential <PSCredential>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Office <String>] [-Password <SecureString>] [-Phone <String>] [-ResourceCapacity <Int32>] [-SendModerationNotifications <Never | Internal | Always>] [-UserPrincipalName <String>] <COMMON PARAMETERS>

New-Mailbox -UserPrincipalName <String> [-ArbitrationMailbox <MailboxIdParameter>] [-MailboxPlan <MailboxPlanIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-SendModerationNotifications <Never | Internal | Always>] <COMMON PARAMETERS>

New-Mailbox -MicrosoftOnlineServicesID <WindowsLiveId> -Password <SecureString> [-ArbitrationMailbox <MailboxIdParameter>] [-InactiveMailbox <MailboxIdParameter>] [-MailboxPlan <MailboxPlanIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-RemovedMailbox <RemovedMailboxIdParameter>] [-SendModerationNotifications <Never | Internal | Always>] <COMMON PARAMETERS>

New-Mailbox -Password <SecureString> -WindowsLiveID <WindowsLiveId> [-ArbitrationMailbox <MailboxIdParameter>] [-EvictLiveId <SwitchParameter>] [-InactiveMailbox <MailboxIdParameter>] [-MailboxPlan <MailboxPlanIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-RemovedMailbox <RemovedMailboxIdParameter>] [-SendModerationNotifications <Never | Internal | Always>] <COMMON PARAMETERS>

New-Mailbox -UseExistingLiveId <SwitchParameter> -WindowsLiveID <WindowsLiveId> [-ArbitrationMailbox <MailboxIdParameter>] [-InactiveMailbox <MailboxIdParameter>] [-MailboxPlan <MailboxPlanIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-RemovedMailbox <RemovedMailboxIdParameter>] [-SendModerationNotifications <Never | Internal | Always>] <COMMON PARAMETERS>

New-Mailbox -AccountDisabled <SwitchParameter> [-ArbitrationMailbox <MailboxIdParameter>] [-MailboxPlan <MailboxPlanIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Password <SecureString>] [-SendModerationNotifications <Never | Internal | Always>] [-UserPrincipalName <String>] <COMMON PARAMETERS>

New-Mailbox -ImportLiveId <SwitchParameter> -WindowsLiveID <WindowsLiveId> [-ArbitrationMailbox <MailboxIdParameter>] [-MailboxPlan <MailboxPlanIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-RemovedMailbox <RemovedMailboxIdParameter>] [-SendModerationNotifications <Never | Internal | Always>] <COMMON PARAMETERS>

New-Mailbox -RemovedMailbox <RemovedMailboxIdParameter> [-ArbitrationMailbox <MailboxIdParameter>] [-MailboxPlan <MailboxPlanIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Password <SecureString>] [-SendModerationNotifications <Never | Internal | Always>] <COMMON PARAMETERS>

New-Mailbox -InactiveMailbox <MailboxIdParameter> [-MailboxPlan <MailboxPlanIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Password <SecureString>] [-SendModerationNotifications <Never | Internal | Always>] <COMMON PARAMETERS>

New-Mailbox -FederatedIdentity <String> -WindowsLiveID <WindowsLiveId> [-EvictLiveId <SwitchParameter>] [-MailboxPlan <MailboxPlanIdParameter>] [-RemovedMailbox <RemovedMailboxIdParameter>] <COMMON PARAMETERS>

New-Mailbox -FederatedIdentity <String> -MicrosoftOnlineServicesID <WindowsLiveId> [-MailboxPlan <MailboxPlanIdParameter>] [-RemovedMailbox <RemovedMailboxIdParameter>] <COMMON PARAMETERS>

New-Mailbox -ArchiveDomain <SmtpDomain> -Password <SecureString> -UserPrincipalName <String> [-ArbitrationMailbox <MailboxIdParameter>] [-MailboxPlan <MailboxPlanIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-RemoteArchive <SwitchParameter>] [-RemovedMailbox <RemovedMailboxIdParameter>] [-SendModerationNotifications <Never | Internal | Always>] <COMMON PARAMETERS>

New-Mailbox -Scheduling <SwitchParameter> [-Password <SecureString>] [-UserPrincipalName <String>] <COMMON PARAMETERS>

New-Mailbox -Shared <SwitchParameter> [-ArbitrationMailbox <MailboxIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Password <SecureString>] [-SendModerationNotifications <Never | Internal | Always>] [-UserPrincipalName <String>] <COMMON PARAMETERS>

New-Mailbox [-ArbitrationMailbox <MailboxIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Password <SecureString>] [-SendModerationNotifications <Never | Internal | Always>] [-UserPrincipalName <String>] <COMMON PARAMETERS>

New-Mailbox -Arbitration <SwitchParameter> -UserPrincipalName <String> [-Password <SecureString>] <COMMON PARAMETERS>

New-Mailbox -Discovery <SwitchParameter> [-Password <SecureString>] [-UserPrincipalName <String>] <COMMON PARAMETERS>

New-Mailbox -Equipment <SwitchParameter> [-ArbitrationMailbox <MailboxIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Password <SecureString>] [-SendModerationNotifications <Never | Internal | Always>] [-UserPrincipalName <String>] <COMMON PARAMETERS>

New-Mailbox [-ArbitrationMailbox <MailboxIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Password <SecureString>] [-SendModerationNotifications <Never | Internal | Always>] [-UserPrincipalName <String>] <COMMON PARAMETERS>

New-Mailbox -LinkedDomainController <String> -LinkedMasterAccount <UserIdParameter> [-ArbitrationMailbox <MailboxIdParameter>] [-LinkedCredential <PSCredential>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Password <SecureString>] [-SendModerationNotifications <Never | Internal | Always>] [-UserPrincipalName <String>] <COMMON PARAMETERS>

New-Mailbox [-ArbitrationMailbox <MailboxIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Password <SecureString>] [-SendModerationNotifications <Never | Internal | Always>] [-UserPrincipalName <String>] <COMMON PARAMETERS>

New-Mailbox -EnableRoomMailboxAccount <$true | $false> -Room <SwitchParameter> [-MicrosoftOnlineServicesID <WindowsLiveId>] [-RoomMailboxPassword <SecureString>] [-UserPrincipalName <String>] <COMMON PARAMETERS>

New-Mailbox -AuditLog <SwitchParameter> -UserPrincipalName <String> <COMMON PARAMETERS>

New-Mailbox -AuxAuditLog <SwitchParameter> [-UserPrincipalName <String>] <COMMON PARAMETERS>

New-Mailbox [-ArbitrationMailbox <MailboxIdParameter>] [-ModeratedBy <MultiValuedProperty>] [-SendModerationNotifications <Never | Internal | Always>] <COMMON PARAMETERS>

New-Mailbox -PublicFolder <SwitchParameter> [-HoldForMigration <SwitchParameter>] [-IsExcludedFromServingHierarchy <$true | $false>] <COMMON PARAMETERS>

COMMON PARAMETERS: -Name <String> [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] [-Alias <String>] [-Archive <SwitchParameter>] [-ArchiveDatabase <DatabaseIdParameter>] [-Confirm [<SwitchParameter>]] [-Database <DatabaseIdParameter>] [-DisplayName <String>] [-DomainController <Fqdn>] [-FirstName <String>] [-Force <SwitchParameter>] [-ImmutableId <String>] [-Initials <String>] [-LastName <String>] [-MailboxProvisioningConstraint <MailboxProvisioningConstraint>] [-MailboxProvisioningPreferences <MultiValuedProperty>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-PrimarySmtpAddress <SmtpAddress>] [-RemotePowerShellEnabled <$true | $false>] [-ResetPasswordOnNextLogon <$true | $false>] [-RetentionPolicy <MailboxPolicyIdParameter>] [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] [-SamAccountName <String>] [-SharingPolicy <SharingPolicyIdParameter>] [-SkipMailboxProvisioningConstraintValidation <SwitchParameter>] [-TargetAllMDBs <SwitchParameter>] [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] [-WhatIf [<SwitchParameter>]]

This example creates a user Chris Ashton in Active Directory and creates a mailbox for the user. The mailbox is located on Mailbox Database 1. The password must be reset at the next logon. To set the initial value of the password, this example creates a variable ($password), prompts you to enter a password, and assigns that password to the variable as a SecureString object.

$password = Read-Host "Enter password" -AsSecureString
New-Mailbox -UserPrincipalName chris@contoso.com -Alias chris -Database "Mailbox Database 1" -Name ChrisAshton -OrganizationalUnit Users -Password $password -FirstName Chris -LastName Ashton -DisplayName "Chris Ashton" -ResetPasswordOnNextLogon $true

This example creates a user in Active Directory and a resource mailbox for a conference room. The resource mailbox is located in Mailbox Database 1. The password must be reset at the next logon. You are prompted for the value of the initial password because it's not specified.

New-Mailbox -UserPrincipalName confmbx@contoso.com -Alias confmbx -Name ConfRoomMailbox -Database "Mailbox Database 1" -OrganizationalUnit Users -Room -ResetPasswordOnNextLogon $true

This example creates an enabled user account in Active Directory and a room mailbox for a conference room in an on-premises Exchange organization. The RoomMailboxPassword parameter specifies the password for the user account.

New-Mailbox -UserPrincipalName confroom1010@contoso.com -Alias confroom1010 -Name "Conference Room 1010" -Room -EnableRoomMailboxAccount $true -RoomMailboxPassword (ConvertTo-SecureString -String P@ssw0rd -AsPlainText -Force)

This example creates the shared mailbox "Sales Department" and grants Full Access and Send on Behalf permissions for the security group "MarketingSG". Users who are members of the security group will be granted the permissions to the mailbox.

noteNote:
This example assumes that you've already created a mail-enabled security group named "MarketingSG" by using the New-DistributionGroup cmdlet.
New-Mailbox -Shared -Name "Sales Department" -DisplayName "Sales Department" -Alias Sales
Set-Mailbox -Identity Sales -GrantSendOnBehalfTo MarketingSG
Add-MailboxPermission -Identity Sales -User MarketingSG -AccessRights FullAccess -InheritanceType All

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

AccountDisabled

Required

System.Management.Automation.SwitchParameter

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

The AccountDisabledswitch specifies that the user account that's associated with the mailbox is disabled.The mailbox is created, and the associated account is created, but the account is disabled, so you can't log on to the mailbox. You don't need to specify a value with this switch.

Arbitration

Required

System.Management.Automation.SwitchParameter

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

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 2016.

The ArchiveDomain parameter specifies the domain in the cloud-based service where the archive that's 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 the cloud-based service.

AuditLog

Required

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

AuxAuditLog

Required

System.Management.Automation.SwitchParameter

PARAMVALUE: SwitchParameter

Discovery

Required

System.Management.Automation.SwitchParameter

The Discoveryswitch specifies that the mailbox is a Discovery mailbox. You don't need to specify a value with this switch. This switch is required only if you're creating a Discovery mailbox.

Discovery mailboxes are created as target mailboxes for Discovery searches. After being created or enabled, a Discovery mailbox can't be repurposed or converted to another type of mailbox. For more information, see In-Place eDiscovery in Exchange 2016.

EnableRoomMailboxAccount

Required

System.Boolean

The EnableRoomMailboxAccount parameter specifies whether to enable the disabled user account that's associated with this room mailbox. Valid values are:

  • $true   The disabled account that's associated with the room mailbox is enabled. You also need to use the RoomMailboxPassword with this value. This allows the account to log on to the room mailbox.

  • $false   The account that's associated with the room mailbox is disabled. You can't use the account to logon to the room mailbox. This is the default value.

You need to use this parameter with the Room switch.

Typically, the account that's associated with a room mailbox is disabled. However, you need to enable the account for features like the Lync Room System or the Skype for Business Room System.

In Exchange Online, a room mailbox with an associated enabled account doesn't require a license.

Equipment

Required

System.Management.Automation.SwitchParameter

The Equipmentswitch specifies that the resource mailbox is an equipment mailbox.You don't need to specify a value with this switch. This switch is required only if you're creating an equipment resource mailbox.

FederatedIdentity

Required

System.String

This parameter is available only in the cloud-based service.

The FederatedIdentity parameter associates an on-premises Active Directory user with a user in the cloud.

ImportLiveId

Required

System.Management.Automation.SwitchParameter

This parameter is available only in the cloud-based service.

The ImportLiveID switch specifies whether to import an unmanaged Microsoft account (formerly known as a Windows Live ID) into the cloud-based domain. You don't need to specify a value with this switch.

An unmanaged Microsoft account was created in the domain before the domain was enrolled in the cloud-based service. Importing a Microsoft account into the domain lets you save any settings associated with the Microsoft account, like instant messaging contacts. However, the Microsoft account is now subject to the security and privacy policies of the organization.

LinkedDomainController

Required

System.String

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

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

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

LinkedMasterAccount

Required

Microsoft.Exchange.Configuration.Tasks.UserIdParameter

The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if the mailbox is a linked mailbox. The master account is the account that the mailbox is linked to. The master account grants access to the mailbox. You can use any value that uniquely identifies the master account.

For example:

  • Name

  • Display name

  • Distinguished name (DN)

  • Canonical DN

  • GUID

LinkedRoom

Required

System.Management.Automation.SwitchParameter

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

The LinkedRoom switch specifies that the mailbox is a linked resource mailbox. You don't need to specify a value with this switch.

A linked resource mailbox is useful in a scenario where you have an account in an authentication forest and you want it to be directly linked to a resource mailbox in resource forest.

MicrosoftOnlineServicesID

Required

Microsoft.Exchange.Data.WindowsLiveId

This parameter is available only in the cloud-based service.

The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter only applies to objects in the cloud-based service. It isn’t available for on-premises deployments.

Name

Required

System.String

The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").

Password

Required

System.Security.SecureString

The Password parameter specifies the password for the mailbox (the user account that's associated with the mailbox). This parameter isn't required if you're creating a linked mailbox, resource mailbox, or shared mailbox, because the associated user accounts are disabled for these types of mailboxes.

This parameter uses the syntax (ConvertTo-SecureString -String '<password>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter.

PublicFolder

Required

System.Management.Automation.SwitchParameter

The PublicFolderswitch specifies that the mailbox is a public folder mailbox. You don't need to specify a value with this switch. This switch is required onlyif you're creating a public folder mailbox.

Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders. The first public folder mailbox created in your Exchange organization is called the primary hierarchy mailbox. It contains the writeable copy of the hierarchy of public folders for the organization and public folder content. There can be only one writeable copy of the public folder hierarchy in your organization. All other public folder mailboxes are called secondary public folder mailboxes and contain a read-only copy of the hierarchy and the content for public folders.

Room

Required

System.Management.Automation.SwitchParameter

The Roomswitch specifies that the resource mailbox is a room mailbox.You don't need to specify a value with this switch. This parameter is required only if you're creating a room resource mailbox.

When you create a room mailbox using only the Room parameter, a logon-disabled account is created with the mailbox. The logon-disabled state of the account prevents users from signing in to the mailbox. When you use the EnableRoomMailboxAccount and RoomMailboxPassword parameters, you can mail-enable the associated account.

Scheduling

Required

System.Management.Automation.SwitchParameter

PARAMVALUE: SwitchParameter

Shared

Required

System.Management.Automation.SwitchParameter

The Shared parameter specifies that the mailbox is a shared mailbox. You don't need to specify a value with this switch. This switch is required only if you're creating a shared mailbox.

A shared mailbox is a mailbox where multiple users can log on to access the mailbox contents. The mailbox isn't associated with any of the users that can log on. It's associated with a disabled user account.

UseExistingLiveId

Required

System.Management.Automation.SwitchParameter

This parameter is available only in the cloud-based service.

The UseExistingLiveId switch specifies whether to use the specified Microsoft account (formerly known as a Windows Live ID) that already exists in the cloud-based domain. The specified Microsoft account can't have a mail user associated with it.

You don't need to specify a value with this switch.

UserPrincipalName

Required

System.String

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

The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format <username>@<domain>. Typically, the <domain> value is the domain where the user account resides.

WindowsLiveID

Required

Microsoft.Exchange.Data.WindowsLiveId

This parameter is available only in the cloud-based service.

The WindowsLiveID parameter specifies the Microsoft account (formerly known as a Windows Live ID) of the mailbox.

ActiveSyncMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The ActiveSyncMailboxPolicy parameter specifies the mobile device mailbox policy that's applied to the mailbox. You can use any value that uniquely identifies the policy. For example:.

  • Name

  • Distinguished name (DN)

  • GUID

If you don't use this parameter, the default mobile device mailbox policy is used.

AddressBookPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.AddressBookMailboxPolicyIdParameter

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

The AddressBookPolicy parameter specifies the address book policy that's applied to the mailbox. You can use any value that uniquely identifies the address book policy. For example:

  • Name

  • Distinguished name (DN)

  • GUID

For more information about address book policies, see Address book policies in Exchange 2016.

Alias

Optional

System.String

The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value.

The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', *, +, -, /, =, ?, ^, _, `, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters.

When you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (<alias>@<domain>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (ö) is changed to oe in the primary email address.

If you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value:

  • Recipients with user accounts (for example, user mailboxes, and mail users)   The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, helpdesk@contoso.com results in the Alias property value helpdesk.

  • Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups)   The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?).

If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in on-premises environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient).

noteNote:
The Alias parameter never generates or updates the primary email address of a mail contact or a mail user.

ArbitrationMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

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

The ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration mailbox.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

Archive

Optional

System.Management.Automation.SwitchParameter

The Archiveswitch specifies that an archive mailbox is created for this mailbox. You don't need to specify a value with this switch.

ArchiveDatabase

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

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

The ArchiveDatabase parameter specifies the Exchange database that contains the archive that's associated with this mailbox. You can use any value that uniquely identifies the database. For example:

  • Name

  • Distinguished name (DN)

  • GUID

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

Database

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

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

The Database parameter specifies the mailbox database that contains the mailbox. You can use any value that uniquely identifies the database. For example:

  • Name

  • Distinguished name (DN)

  • GUID

Use the Get-MailboxDatabase cmdlet to see the available mailbox databases.

DisplayName

Optional

System.String

The DisplayName parameter specifies the display name of the mailbox. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (").

If you don't use the DisplayName parameter, the value of the Name parameter is used for the display name.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

EvictLiveId

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in the cloud-based service.

The EvictLiveId switch specifies whether to remove an unmanaged Microsoft account (formerly known as a Windows Live ID) from the cloud-based domain. An unmanaged Microsoft account was created in the domain before the domain was enrolled in the cloud-based service. Evicting a Microsoft account from the domain lets you save any settings associated with the Microsoft account, like instant messaging contacts.

You don't need to specify a value with this switch.

FirstName

Optional

System.String

The FirstName parameter specifies the user's first name.

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch.

HoldForMigration

Optional

System.Management.Automation.SwitchParameter

The HoldForMigration switch specifies whether to prevent any client or user, except the Microsoft Exchange Mailbox Replication service (MRS) process, from logging on to a public folder mailbox. You don't need to specify a value with this switch.

You need to use this parameter when you create the first public folder, which is called the hierarchy mailbox, in your organization.

warningWarning:
Use this parameter only if you plan to migrate legacy Exchange 2010 public folders to Exchange 2016. If you use this switch but don't have legacy public folders to migrate, you won't be able to create any public folders.

ImmutableId

Optional

System.String

The ImmutableId parameter is used by GAL synchronization (GALSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mailbox and you don't set this parameter when you create the mailbox, Exchange creates the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account namespace, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com.

You need to set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into an off-premises mailbox and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premises Exchange deployment scenario.

InactiveMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

PARAMVALUE: MailboxIdParameter

Initials

Optional

System.String

The Initials parameter specifies the user's middle initials.

IsExcludedFromServingHierarchy

Optional

System.Boolean

The IsExcludedFromServingHierarchy parameter prevents users from accessing the public folder hierarchy on this public folder mailbox. For load-balancing purposes, users are equally distributed across public folder mailboxes by default. When this parameter is set on a public folder mailbox, that mailbox isn't included in this automatic load-balancing and won't be accessed by users to retrieve the public folder hierarchy. However, if an administrator has set the DefaultPublicFolderMailbox property on a user mailbox to a specific public folder mailbox, the user will still access the specified public folder mailbox even if the IsExcludedFromServingHierarchy parameter is set for that public folder mailbox.

LastName

Optional

System.String

The LastName parameter specifies the user's last name.

LinkedCredential

Optional

System.Management.Automation.PSCredential

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

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.

This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential.

MailboxPlan

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPlanIdParameter

This parameter is available only in the cloud-based service.

The MailboxPlan parameter specifies the mailbox plan to applytothe mailbox. You can use any value that uniquely identifies the mailbox plan. For example:

  • Name

  • Alias

  • Display name

  • Distinguished name (DN)

  • GUID

A mailbox plan specifies the permissions and features that are available to a mailbox. In Office 365, mailbox plans correspond to the subscriptions and licenses that administrators purchase and assign in the Office 365 admin center.

You can see the available mailbox plans by using the Get-MailboxPlan cmdlet.

MailboxProvisioningConstraint

Optional

Microsoft.Exchange.Data.Directory.MailboxProvisioningConstraint

This parameter is reserved for internal Microsoft use.

MailboxProvisioningPreferences

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is reserved for internal Microsoft use.

ModeratedBy

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • Email address

  • GUID

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

You need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true.

ModerationEnabled

Optional

System.Boolean

The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are:

  • $true   Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered.

  • $false   Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value.

You use the ModeratedBy parameter to specify the moderators.

Office

Optional

System.String

The Office parameter specifies the user's physical office name or number.

OrganizationalUnit

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

The OrganizationalUnit parameter specifies the location in Active Directory where the new mailbox is created.

Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:

  • Name

  • Canonical name

  • Distinguished name (DN)

  • GUID

Phone

Optional

System.String

The Phone parameter specifies the user's telephone number.

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command.

If you use the PrimarySmtpAddress parameter to specify the primary email address, the command sets the EmailAddressPolicyEnabled property of the mailbox to False, which means the email addresses of the mailbox aren't automatically updated by email address policies.

RemoteArchive

Optional

System.Management.Automation.SwitchParameter

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

The RemoteArchive switch specifies that a remote archive mailbox is created for this mailbox. A remote archive exists in the cloud-based service. You don't need to specify a value with this switch.

RemotePowerShellEnabled

Optional

System.Boolean

The RemotePowerShellEnabled parameter specifies whether the user has access to remote PowerShell. Valid values are:

  • $true   The user has access to Exchange Online PowerShell, the Exchange Management Shell, and the Exchange admin center (EAC). This is the default value.

  • $false   The user has doesn't have access to Exchange Online PowerShell, the Exchange Management Shell, or the EAC.

Access to remote PowerShell is required even if you're trying to open the Exchange Management Shell or the EAC on the local Exchange server.

noteNote:
A user's experience in any of these management interfaces is still controlled by the role-based access control (RBAC) permissions that are assigned to them.

RemovedMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.RemovedMailboxIdParameter

This parameter is reserved for internal Microsoft use.

ResetPasswordOnNextLogon

Optional

System.Boolean

The ResetPasswordOnNextLogon parameter specifies whether the user is required to change their password the next time they log on to their mailbox. Valid values are:

  • $true   The user is required to change their password the next time they log on to their mailbox.

  • $false   The user isn't required to change their password the next time they log on to their mailbox. This is the default value.

ResourceCapacity

Optional

System.Int32

The ResourceCapacity parameter specifies the capacity of the resource mailbox. For example, you can use this parameter to identify the number of seats in a conference room (room mailbox) or in a vehicle (equipment mailbox). A valid value is an integer.

RetentionPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

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

The RetentionPolicy parameter specifies the retention policy that you want applied to this mailbox. You can use any value that uniquely identifies the policy. For example:

  • Name

  • Distinguished Name (DN)

  • GUID

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.

Use the Get-RetentionPolicy cmdlet to see the available retention policies.

If you don't use this parameter, the retention policy named Default MRM Policy is applied to the mailbox.

RoleAssignmentPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The RoleAssignmentPolicy parameter specifies the role assignment policy that's applied to the mailbox. You can use any value that uniquely identifies the role assignment policy. For example:

  • Name

  • Distinguished name (DN)

  • GUID

In Office 365, if you don't use this parameter, the default role assignment policy named Default Role Assignment Policy is automatically applied to the mailbox. In on-premises Exchange, no role assignment policy is automatically applied to the mailbox.

Use the Get-RoleAssignmentPolicy cmdlet to see the available role assignment policies. For more information about assignment policies, see Understanding management role assignment policies.

RoomMailboxPassword

Optional

System.Security.SecureString

Use the RoomMailboxPassword parameter to configure the password for a room mailbox that has a logon-enabled account (the EnableRoomMailboxAccount parameter is set to the value $true.)

To use this parameter, you need to be a member of one of the following role groups:

  • Office 365   The Organization Management role group via the Mail Recipients, Reset Password, and User Options roles, the Help Desk role group via the Reset Password and User Options roles, or the Recipient Management role group via the Mail Recipients and Reset Password roles.

  • On-premises Exchange   The Organization Management role group via the Mail Recipients and User Options roles, the Recipient Management role group via the Mail Recipients role, or the Help Desk role group via the User Options role. The Reset Password role also allows you to use this parameter, but it isn't assigned to any role groups by default.

This parameter uses the syntax (ConvertTo-SecureString -String '<password>' -AsPlainText -Force). Or, to be prompted to enter the password and store it as a variable, run the command $password = Read-Host "Enter password" -AsSecureString, and then use the value $password for this parameter.

SamAccountName

Optional

System.String

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

The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the characters !, #, $, %, ^, &, -, _, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters.

SendModerationNotifications

Optional

Microsoft.Exchange.Data.Directory.Recipient.TransportModerationNotificationFlags

The SendModerationNotifications parameter specifies whether moderation status notification messages are sent to senders when they send a message to this moderated recipient. Valid values are:

  • Always   Moderation status notifications are sent to all internal and external senders. This is the default value.

  • Internal   Moderation status notifications are sent to all internal senders, but not to external senders.

  • Never   Moderation status notifications are disabled.

Note that senders are always notified if their message is rejected by a moderator, regardless of the value of this parameter.

SharingPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.SharingPolicyIdParameter

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

The SharingPolicy parameter specifies the sharing policy that's applied to the mailbox. You can use any value that uniquely identifies the sharing policy. For example:

  • Name

  • Distinguished name (DN)

  • GUID

Use the Get-SharingPolicy cmdlet to see the available sharing policies.

If you don't use this parameter, the sharing policy named Default Sharing Policy is applied to the mailbox.

SkipMailboxProvisioningConstraintValidation

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

TargetAllMDBs

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

ThrottlingPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.ThrottlingPolicyIdParameter

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

The ThrottlingPolicy parameter specifies the throttling policy that's applied to the mailbox. You can use any value that uniquely identifies the throttling policy. For example:

  • Name

  • Distinguished name (DN)

  • GUID

Use the Get-ThrottlingPolicy cmdlet to see the available throttling policies.

By default, no throttling policy is applied to the mailbox.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this 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.

 
Show:
© 2016 Microsoft