Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxPlanIdParameter

The Identity parameter specifies the mailbox plan. You can use any value that uniquely identifies the mailbox plan, for example:

• Distinguished name (DN)
  
  
• Display name
  
  
• GUID
  
  
• LegacyExchangeDN
  
  
• Name
  
  

AntispamBypassEnabled

Optional

System.Boolean

The AntispamBypassEnabled parameter specifies whether to skip anti-spam processing on this mailbox. The two possible values for this parameter are $true or $false.

ApplyMandatoryProperties

Optional

System.Management.Automation.SwitchParameter

The ApplyMandatoryProperties parameter specifies whether to modify the mandatory properties of a mailbox. Creating a mailbox through the Microsoft Exchange Server 2003 extensions to the Active Directory Users and Computers console isn't supported. If a mailbox is created with this tool, it's identified as a legacy mailbox, even though it resides on a server running Microsoft Exchange Server 2010. This parameter modifies the mandatory properties of a mailbox in this state to correct the problem and remove the legacyMailbox tag from the mailbox.

ArchiveDomain

Optional

Microsoft.Exchange.Data.SmtpDomain

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

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

ArchiveQuota

Optional

Microsoft.Exchange.Data.Unlimited

The ArchiveQuota parameter specifies the archive mailbox size at which messages will no longer be accepted.

When you enter a value, qualify the value with one of the following units:

• B (bytes)
  
  
• KB (kilobytes)
  
  
• MB (megabytes)
  
  
• GB (gigabytes)
  
  
• TB (terabytes)
  
  

Unqualified values are treated as bytes. The value must be greater than the value of the ArchiveWarningQuota parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes.

ArchiveStatus

Optional

Microsoft.Exchange.Data.Directory.Recipient.ArchiveStatusFlags

This parameter is reserved for internal Microsoft use.

ArchiveWarningQuota

Optional

Microsoft.Exchange.Data.Unlimited

The ArchiveWarningQuota parameter specifies the archive mailbox size at which a warning message is sent to the user.

When you enter a value, qualify the value with one of the following units:

• B (bytes)
  
  
• KB (kilobytes)
  
  
• MB (megabytes)
  
  
• GB (gigabytes)
  
  
• TB (terabytes)
  
  

Unqualified values are treated as bytes. The value must be less than the value of the ArchiveQuota parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes.

AuditAdmin

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AuditAdmin parameter specifies the operations to log for administrators. Valid values include:

• None
  
  
• Update
  
  
• Copy
  
  
• Move
  
  
• MoveToDeletedItems
  
  
• SoftDelete
  
  
• HardDelete
  
  
• FolderBind
  
  
• SendAs
  
  
• SendOnBehalf
  
  
• MessageBind
  
  

By default, the Update, Move, MoveToDeletedItems, SoftDelete, HardDelete, FolderBind, SendAs, and SendOnBehalf actions performed by administrators are logged.

Note:
The AuditEnabled parameter must be set to $true to enable logging.

AuditDelegate

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AuditDelegate parameter specifies the operations to log for delegate users. Valid values include:

• None
  
  
• Update
  
  
• Copy
  
  
• Move
  
  
• MoveToDeletedItems
  
  
• SoftDelete
  
  
• HardDelete
  
  
• FolderBind
  
  
• SendAs
  
  
• SendOnBehalf
  
  
• MessageBind
  
  

By default, the Update, SoftDelete, HardDelete, and SendAs actions performed by delegates are logged.

Note:
The AuditEnabled parameter must be set to $true to enable logging.

AuditEnabled

Optional

System.Boolean

The AuditEnabled parameter specifies whether to enable or disable mailbox audit logging. If auditing is enabled, actions specified in the AuditAdmin, AuditDelegate, and AuditOwner parameters are logged. Valid values include:

• $true   Mailbox audit logging is enabled.
  
  
• $false   Mailbox audit logging is disabled.
  
  

The default value is $false.

AuditLogAgeLimit

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The AuditLogAgeLimit parameter specifies the period for which audit logs for a mailbox are retained. Logs older than the specified period are removed. The default value is 90 days.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

For example, to specify 10 days for this parameter, use 10.00:00:00. The valid input range for this parameter is from 00:00:00 through 24855.03:14:07. Setting the value of this parameter to 00:00:00 prevents the automatic removal of server statistics log files.

AuditOwner

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AuditOwner parameter specifies the operations to log for mailbox owners. Valid values include:

• None
  
  
• Update
  
  
• Move
  
  
• MoveToDeletedItems
  
  
• SoftDelete
  
  
• HardDelete
  
  

By default, mailbox access by the owner isn't logged.

Note:
The AuditEnabled parameter must be set to $true to enable logging.

CalendarRepairDisabled

Optional

System.Boolean

The CalendarRepairDisabled parameter specifies that this mailbox won't have its calendar items repaired by the Calendar Repair Assistant. The two possible values for this parameter are $true or $false. The default is $false.

CalendarVersionStoreDisabled

Optional

System.Boolean

The CalendarVersionStoreDisabled parameter specifies that calendar changes in a user's mailbox aren't logged. The two possible values for this parameter are $true or $false. The default value is $false. By default, all changes to a calendar item are recorded in the mailbox of a user to keep older versions of meeting items.

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 the database that contains the mailbox object. You can use one of the following values:

• GUID
  
  
• Database name
  
  

DeliverToMailboxAndForward

Optional

System.Boolean

The DeliverToMailboxAndForward parameter specifies whether messages sent to this mailbox are forwarded to another address.

If the DeliverToMailboxAndForward parameter is set to $true, messages are delivered to the mailbox and to the forwarding address.

If set to $false, messages are delivered only to the forwarding address.

DisplayName

Optional

System.String

The DisplayName parameter specifies the display name for the user account associated with this mailbox. The display name is used by Microsoft Outlook.

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.

DowngradeHighPriorityMessagesEnabled

Optional

System.Boolean

The DowngradeHighPriorityMessagesEnabled parameter specifies whether to prevent the mailbox from sending high priority messages to an X.400 mail system. If this parameter is set to $true and the mailbox sends a high priority message destined to an X.400 mail system, the message priority is changed to normal priority.

EmailAddressPolicyEnabled

Optional

System.Boolean

The EmailAddressPolicyEnabled parameter specifies whether the e-mail address policy for this mailbox is enabled. The two possible values for this parameter are $true or $false.

EndDateForRetentionHold

Optional

System.DateTime

The EndDateForRetentionHold parameter specifies the end date for retention hold for messaging records management (MRM). To use this parameter, the RetentionHoldEnabled parameter must be set to $true.

ExternalOofOptions

Optional

Microsoft.Exchange.Data.Directory.Recipient.ExternalOofOptions

The ExternalOofOptions parameter specifies the option for sending an out-of-office message to external senders. You can use the following values:

• External
  
  
• InternalOnly
  
  

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress warning or confirmation messages. This switch can be used when the task is run programmatically and prompting for administrative input is inappropriate. If the Force switch isn't provided in the command, you're prompted for administrative input. You don't have to specify a value with this parameter.

HiddenFromAddressListsEnabled

Optional

System.Boolean

The HiddenFromAddressListsEnabled parameter specifies whether this mailbox is hidden from other address lists. The two possible values for this parameter are $true or $false.

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 GUID, isn't accepted.
  
  

IsDefault

Optional

System.Management.Automation.SwitchParameter

The IsDefault parameter specifies that the mailbox plan is the default mailbox plan. When mailboxes are created, they receive this mailbox plan by default.

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

IsDefaultForPreviousVersion

Optional

System.Management.Automation.SwitchParameter

The IsDefaultForPreviousVersion parameter specifies that the mailbox plan was the default mailbox plan in a previous version of the service plan.

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

IssueWarningQuota

Optional

Microsoft.Exchange.Data.Unlimited

The IssueWarningQuota parameter specifies the mailbox size at which a warning message is sent to the user.

You must specify either an integer or unlimited.

If you set this attribute on a mailbox, this mailbox attribute overrides the value set for the corresponding attribute on the mailbox database.

LitigationHoldDate

Optional

System.DateTime

The LitigationHoldDate parameter specifies the date when the mailbox is placed on litigation hold. The parameter is populated automatically when placing a mailbox on litigation hold. This can be used for informational or reporting purposes.

Note:
When using the Exchange Management Shell to place the mailbox on litigation hold, you can optionally specify any date as the LitigationHoldDate, but the mailbox is placed on litigation hold when the cmdlet is run.

LitigationHoldEnabled

Optional

System.Boolean

The LitigationHoldEnabled parameter specifies that the mailbox is under litigation hold and that messages can't be deleted from the user's account. The two possible values for this parameter are $true or $false. The default value is $false. After a mailbox is placed on litigation hold, deleted items and all versions of changed items are retained in the Recoverable Items folder. Items that are purged from the dumpster are also retained, and the items are held indefinitely. If you enable litigation hold, single item recovery quotas aren't applied.

LitigationHoldOwner

Optional

System.String

The LitigationHoldOwner parameter specifies the user who placed the mailbox on litigation hold. The parameter is populated automatically when placing a mailbox on litigation hold. This can be used for informational or reporting purposes.

Note:
When using the Shell to place a mailbox on litigation hold, you can optionally specify a string value for this parameter.

MailboxPlanRelease

Optional

Microsoft.Exchange.Data.Directory.Recipient.MailboxPlanRelease

This parameter is reserved for internal Microsoft use.

ManagedFolderMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

This parameter is reserved for internal Microsoft use.

MaxBlockedSenders

Optional

System.Int32

The MaxBlockedSenders parameter specifies the maximum number of senders that can be included in the Blocked Senders List. Blocked senders are senders that are considered junk senders by the mailbox user and are used in junk e-mail rules. This parameter is validated only when the junk e-mail rules are updated using Outlook Web App or Exchange Web services.

MaxReceiveSize

Optional

Microsoft.Exchange.Data.Unlimited

The MaxReceiveSize parameter specifies the maximum size of messages that this mailbox can receive. You must specify either an integer or unlimited.

MaxSafeSenders

Optional

System.Int32

The MaxSafeSenders parameter specifies the maximum number of senders that can be included in the Safe Senders List. Safe senders are senders that are trusted by the mailbox user and are used in junk e-mail rules. This parameter is only validated when the junk e-mail rules are updated using cloud-based organizations or services.

MaxSendSize

Optional

Microsoft.Exchange.Data.Unlimited

The MaxSendSize parameter specifies the maximum size of messages that this mailbox can send. You must specify either an integer or unlimited.

MessageTrackingReadStatusEnabled

Optional

System.Boolean

The MessageTrackingReadStatusEnabled parameter specifies that this mailbox can view the read status of sent messages. The two possible values for this parameter are $true or $false. If you set this parameter to $false, the read status won't be displayed to senders who view delivery reports for messages they send to this user and only the time that the message was delivered to the mailbox is available. The default value is $true.

Name

Optional

System.String

The Name parameter specifies the Name attribute for this mailbox plan. Use this parameter to change the name.

OfflineAddressBook

Optional

Microsoft.Exchange.Configuration.Tasks.OfflineAddressBookIdParameter

The OfflineAddressBook parameter specifies the associated offline address book (OAB).

ProhibitSendQuota

Optional

Microsoft.Exchange.Data.Unlimited

The ProhibitSendQuota parameter specifies the mailbox size at which the user associated with this mailbox can no longer send messages.

You must specify either an integer or unlimited.

If you set this attribute on a mailbox, this mailbox attribute overrides the value set for the corresponding attribute on the mailbox database.

ProhibitSendReceiveQuota

Optional

Microsoft.Exchange.Data.Unlimited

The ProhibitSendReceiveQuota parameter specifies the mailbox size at which the user associated with this mailbox can no longer send or receive messages.

You must specify either an integer or unlimited.

If you set this attribute on a mailbox, this mailbox attribute overrides the value set for the corresponding attribute on the mailbox database.

QueryBaseDNRestrictionEnabled

Optional

System.Boolean

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 QueryBaseDNRestrictionEnabled parameter specifies whether to restrict a user's ability to view or search for other mailboxes in their organization. If this parameter is set to $true, the global address list (GAL) of the specified mailbox user isn't populated. Specifically, if the user views the GAL, it will appear empty. If this parameter is set to $false, users can use the GAL to view all mailboxes in their organization, including mailboxes for which this parameter is set to $true. The default value is $false.

RecipientLimits

Optional

Microsoft.Exchange.Data.Unlimited

The RecipientLimits parameter specifies the maximum number of recipients per message to which this mailbox can send.

You must specify either an integer or unlimited.

If you set this attribute on a mailbox, this mailbox attribute overrides the value set for the corresponding attribute on the Hub Transport server.

RecoverableItemsQuota

Optional

Microsoft.Exchange.Data.Unlimited

The RecoverableItemsQuota parameter specifies the limit for the Recovery Items folder. When you reach the quota limit, you can't put any more items in the Recovery Items folder.

RecoverableItemsWarningQuota

Optional

Microsoft.Exchange.Data.Unlimited

The RecoverableItemsWarningQuota parameter specifies the quota for when a warning event is entered in Event Viewer.

RemoteAccountPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.RemoteAccountPolicyIdParameter

This parameter is reserved for internal Microsoft use.

RemoteRecipientType

Optional

Microsoft.Exchange.Data.Directory.Recipient.RemoteRecipientType

This parameter is reserved for internal Microsoft use.

RequireSenderAuthenticationEnabled

Optional

System.Boolean

The RequireSenderAuthenticationEnabled parameter specifies whether senders must be authenticated. The two possible values for this parameter are $true or $false.

ResetPasswordOnNextLogon

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

RetainDeletedItemsFor

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The RetainDeletedItemsFor parameter specifies the length of time to keep deleted items.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

For example, to specify a 15-hour interval, enter 15:00:00.

RetainDeletedItemsUntilBackup

Optional

System.Boolean

The RetainDeletedItemsUntilBackup parameter specifies whether to retain deleted items until the next backup. The two possible values for this parameter are $true or $false.

RetentionComment

Optional

System.String

The RetentionComment parameter specifies a comment displayed in Outlook regarding the user's retention hold status.

This comment can only be set if the RetentionHoldEnabled parameter is set to $true. This comment should be localized to the user's preferred language.

RetentionHoldEnabled

Optional

System.Boolean

The RetentionHoldEnabled parameter specifies whether retention hold is enabled for messaging retention policies. The two possible values for this parameter are $true or $false. To set the start date for retention hold, use the StartDateForRetentionHold 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 applied to mailbox folders and mail items to determine the period of time that the items should be retained.

RetentionUrl

Optional

System.String

The RetentionUrl parameter specifies the URL or an external Web page with additional details about the organization's messaging retention policies.

This URL can be used to expose details regarding retention policies in general, which is usually a customized legal or IT Web site for the company.

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.

RulesQuota

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

The RulesQuota parameter specifies the limit for the size of rules for this mailbox. When you enter a value, qualify the value with one of the following:

• B (bytes)
  
  
• KB (kilobytes)
  
  
• MB (megabytes)
  
  
• GB (gigabytes)
  
  
• TB (terabytes)
  
  

Unqualified values are treated as bytes.

The default value for this parameter is 64 KB.

Note:
The quota for mailbox rules applies only to enabled rules. There is no restriction on the number of disabled rules a mailbox can have. However, the total size of rules enabled or active can't exceed the value specified for this parameter.

SCLDeleteEnabled

Optional

System.Boolean

The SCLDeleteEnabled parameter specifies whether messages that meet the spam confidence level (SCL) threshold specified by the SCLDeleteThreshold parameter are deleted. You can use the following values:

• $true
  
  
• $false
  
  
• $null
  
  

SCLDeleteThreshold

Optional

System.Int32

The SCLDeleteThreshold parameter specifies the SCL at which a message is deleted, if the SCLDeleteEnabled parameter is set to $true.

You must specify an integer from 0 through 9 inclusive.

SCLJunkEnabled

Optional

System.Boolean

The SCLJunkEnabled parameter specifies whether messages that meet the SCL threshold specified by the SCLJunkThreshold parameter are moved to the Junk E-mail folder. You can use the following values:

• $true
  
  
• $false
  
  
• $null
  
  

SCLJunkThreshold

Optional

System.Int32

The SCLJunkThreshold parameter specifies the SCL threshold. Messages with an SCL greater than the value that you specify for the SCLJunkThreshold parameter are moved to the Junk E-mail folder, if the SCLJunkEnabled parameter is set to $true.

You must specify an integer from 0 through 9 inclusive.

SCLQuarantineEnabled

Optional

System.Boolean

The SCLQuarantineEnabled parameter specifies whether messages that meet the SCL threshold specified by the SCLQuarantineThreshold parameter are quarantined. If a message is quarantined, it's sent to the quarantine mailbox where the messaging administrator can review it. You can use the following values:

• $true
  
  
• $false
  
  
• $null
  
  

SCLQuarantineThreshold

Optional

System.Int32

The SCLQuarantineThreshold parameter specifies the SCL at which a message is quarantined, if the SCLQuarantineEnabled parameter is set to $true.

You must specify an integer from 0 through 9 inclusive.

SCLRejectEnabled

Optional

System.Boolean

The SCLRejectEnabled parameter specifies whether messages that meet the SCL threshold specified by the SCLRejectThreshold parameter are rejected. If a message is rejected, it's deleted and a rejection response is sent to the sender. You can use the following values:

• $true
  
  
• $false
  
  
• $null
  
  

SCLRejectThreshold

Optional

System.Int32

The SCLRejectThreshold parameter specifies the SCL at which a message is rejected, if the SCLRejectEnabled parameter is set to $true.

You must specify an integer from 0 through 9 inclusive.

SharingPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.SharingPolicyIdParameter

The SharingPolicy parameter specifies the sharing policy associated with this mailbox.

SingleItemRecoveryEnabled

Optional

System.Boolean

The SingleItemRecoveryEnabled parameter specifies whether to prevent the Recovery Items folder from being purged. When this parameter is set to $true, it prevents the Recovery Items folder from being purged. It prevents any items from being removed that have been deleted or edited. The possible values for this parameter are $true or $false. The default value is $false.

SKUCapability

Optional

Microsoft.Exchange.Data.Directory.Capability

This parameter is reserved for internal Microsoft use.

StartDateForRetentionHold

Optional

System.DateTime

The StartDateForRetentionHold parameter specifies the start date for retention hold for MRM. To use this parameter, the RetentionHoldEnabled parameter must be set to $true.

ThrottlingPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.ThrottlingPolicyIdParameter

The ThrottlingPolicy parameter specifies the identity of the throttling policy for this mailbox.

UseDatabaseQuotaDefaults

Optional

System.Boolean

The UseDatabaseQuotaDefaults parameter specifies that this mailbox uses the quota attributes specified for the mailbox database where this mailbox resides. The quota attributes are:

• ProhibitSendQuota
  
  
• ProhibitSendReceiveQuota
  
  
• IssueWarningQuota
  
  
• RulesQuota
  
  

The two possible values for this parameter are $true or $false.

UseDatabaseRetentionDefaults

Optional

System.Boolean

The UseDatabaseRetentionDefaults parameter specifies that this mailbox uses the MailboxRetention attribute specified for the mailbox database where this mailbox resides.

The two possible values for this parameter are $true or $false.

UserCertificate

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The UserCertificate parameter specifies the digital certificate used to sign a user's e-mail messages.

UserPrincipalName

Optional

System.String

The UserPrincipalName parameter specifies the user principal name (UPN) for this mailbox. This is the logon name for the user. The UPN consists of a user name and a suffix. Typically, the suffix is the domain name where the user account resides.

UserSMimeCertificate

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The UserSMimeCertificate parameter specifies the S/MIME certificate used to sign a user's e-mail messages.

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.