Export (0) Print
Expand All
Expand Minimize
8 out of 34 rated this helpful - Rate this topic

Set-Mailbox

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-01-10

Use the Set-Mailbox cmdlet to modify the settings of an existing mailbox. You can use this cmdlet for one mailbox at a time. To perform bulk management, you can pipeline the output of various Get- cmdlets (for example, the Get-Mailbox or Get-User cmdlets) and configure several mailboxes in a single-line command. You can also use the Set-Mailbox cmdlet in scripts.

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

Set-Mailbox -Identity <MailboxIdParameter> [-AcceptMessagesOnlyFrom <MultiValuedProperty>] [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] [-AddOnSKUCapability <MultiValuedProperty>] [-AddressBookPolicy <AddressBookMailboxPolicyIdParameter>] [-Alias <String>] [-AntispamBypassEnabled <$true | $false>] [-ApplyMandatoryProperties <SwitchParameter>] [-Arbitration <SwitchParameter>] [-ArbitrationMailbox <MailboxIdParameter>] [-ArchiveDatabase <DatabaseIdParameter>] [-ArchiveDomain <SmtpDomain>] [-ArchiveName <MultiValuedProperty>] [-ArchiveQuota <Unlimited>] [-ArchiveStatus <None | Active>] [-ArchiveWarningQuota <Unlimited>] [-AuditAdmin <MultiValuedProperty>] [-AuditDelegate <MultiValuedProperty>] [-AuditEnabled <$true | $false>] [-AuditLogAgeLimit <EnhancedTimeSpan>] [-AuditOwner <MultiValuedProperty>] [-BypassLiveId <SwitchParameter>] [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] [-CalendarLoggingQuota <Unlimited>] [-CalendarRepairDisabled <$true | $false>] [-CalendarVersionStoreDisabled <$true | $false>] [-ClientExtensions <$true | $false>] [-Confirm [<SwitchParameter>]] [-CreateDTMFMap <$true | $false>] [-CustomAttribute1 <String>] [-CustomAttribute10 <String>] [-CustomAttribute11 <String>] [-CustomAttribute12 <String>] [-CustomAttribute13 <String>] [-CustomAttribute14 <String>] [-CustomAttribute15 <String>] [-CustomAttribute2 <String>] [-CustomAttribute3 <String>] [-CustomAttribute4 <String>] [-CustomAttribute5 <String>] [-CustomAttribute6 <String>] [-CustomAttribute7 <String>] [-CustomAttribute8 <String>] [-CustomAttribute9 <String>] [-Database <DatabaseIdParameter>] [-DefaultPublicFolderMailbox <RecipientIdParameter>] [-DeliverToMailboxAndForward <$true | $false>] [-DisplayName <String>] [-DomainController <Fqdn>] [-DowngradeHighPriorityMessagesEnabled <$true | $false>] [-DumpsterMessagesPerFolderCountReceiveQuota <Int32>] [-DumpsterMessagesPerFolderCountWarningQuota <Int32>] [-EmailAddresses <ProxyAddressCollection>] [-EmailAddressPolicyEnabled <$true | $false>] [-EnableRoomMailboxAccount <$true | $false>] [-EndDateForRetentionHold <DateTime>] [-EvictLiveId <SwitchParameter>] [-ExtensionCustomAttribute1 <MultiValuedProperty>] [-ExtensionCustomAttribute2 <MultiValuedProperty>] [-ExtensionCustomAttribute3 <MultiValuedProperty>] [-ExtensionCustomAttribute4 <MultiValuedProperty>] [-ExtensionCustomAttribute5 <MultiValuedProperty>] [-ExternalOofOptions <InternalOnly | External>] [-FederatedIdentity <String>] [-FolderHierarchyChildrenCountReceiveQuota <Int32>] [-FolderHierarchyChildrenCountWarningQuota <Int32>] [-FolderHierarchyDepthReceiveQuota <Int32>] [-FolderHierarchyDepthWarningQuota <Int32>] [-Force <SwitchParameter>] [-ForwardingAddress <RecipientIdParameter>] [-ForwardingSmtpAddress <ProxyAddress>] [-GMGen <$true | $false>] [-GrantSendOnBehalfTo <MultiValuedProperty>] [-HiddenFromAddressListsEnabled <$true | $false>] [-IgnoreDefaultScope <SwitchParameter>] [-ImListMigrationCompleted <$true | $false>] [-ImmutableId <String>] [-IsExcludedFromServingHierarchy <$true | $false>] [-IssueWarningQuota <Unlimited>] [-JournalArchiveAddress <SmtpAddress>] [-Languages <MultiValuedProperty>] [-LinkedCredential <PSCredential>] [-LinkedDomainController <String>] [-LinkedMasterAccount <UserIdParameter>] [-LitigationHoldDate <DateTime>] [-LitigationHoldDuration <Unlimited>] [-LitigationHoldEnabled <$true | $false>] [-LitigationHoldOwner <String>] [-MailboxMessagesPerFolderCountReceiveQuota <Int32>] [-MailboxMessagesPerFolderCountWarningQuota <Int32>] [-MailboxPlan <MailboxPlanIdParameter>] [-MailRouting <$true | $false>] [-MailTip <String>] [-MailTipTranslations <MultiValuedProperty>] [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] [-ManagedFolderMailboxPolicyAllowed <SwitchParameter>] [-Management <$true | $false>] [-MaxBlockedSenders <Int32>] [-MaxReceiveSize <Unlimited>] [-MaxSafeSenders <Int32>] [-MaxSendSize <Unlimited>] [-MessageTracking <$true | $false>] [-MessageTrackingReadStatusEnabled <$true | $false>] [-MicrosoftOnlineServicesID <SmtpAddress>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Name <String>] [-NetID <NetID>] [-NewPassword <SecureString>] [-OABGen <$true | $false>] [-Office <String>] [-OfflineAddressBook <OfflineAddressBookIdParameter>] [-OldPassword <SecureString>] [-OriginalNetID <NetID>] [-Password <SecureString>] [-PrimarySmtpAddress <SmtpAddress>] [-ProhibitSendQuota <Unlimited>] [-ProhibitSendReceiveQuota <Unlimited>] [-PstProvider <$true | $false>] [-PublicFolder <SwitchParameter>] [-QueryBaseDN <OrganizationalUnitIdParameter>] [-QueryBaseDNRestrictionEnabled <$true | $false>] [-RecipientLimits <Unlimited>] [-RecoverableItemsQuota <Unlimited>] [-RecoverableItemsWarningQuota <Unlimited>] [-RejectMessagesFrom <MultiValuedProperty>] [-RejectMessagesFromDLMembers <MultiValuedProperty>] [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] [-RemoteAccountPolicy <RemoteAccountPolicyIdParameter>] [-RemoteRecipientType <None | ProvisionMailbox | ProvisionArchive | Migrated | DeprovisionMailbox | DeprovisionArchive | RoomMailbox | EquipmentMailbox | SharedMailbox | TeamMailbox>] [-RemoveManagedFolderAndPolicy <SwitchParameter>] [-RemovePicture <SwitchParameter>] [-RemoveSpokenName <SwitchParameter>] [-RequireSecretQA <$true | $false>] [-RequireSenderAuthenticationEnabled <$true | $false>] [-ResetPasswordOnNextLogon <$true | $false>] [-ResourceCapacity <Int32>] [-ResourceCustom <MultiValuedProperty>] [-RetainDeletedItemsFor <EnhancedTimeSpan>] [-RetainDeletedItemsUntilBackup <$true | $false>] [-RetentionComment <String>] [-RetentionHoldEnabled <$true | $false>] [-RetentionPolicy <MailboxPolicyIdParameter>] [-RetentionUrl <String>] [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] [-RoomMailboxPassword <SecureString>] [-RulesQuota <ByteQuantifiedSize>] [-SamAccountName <String>] [-SCLDeleteEnabled <$true | $false>] [-SCLDeleteThreshold <Int32>] [-SCLJunkEnabled <$true | $false>] [-SCLJunkThreshold <Int32>] [-SCLQuarantineEnabled <$true | $false>] [-SCLQuarantineThreshold <Int32>] [-SCLRejectEnabled <$true | $false>] [-SCLRejectThreshold <Int32>] [-SecondaryAddress <String>] [-SecondaryDialPlan <UMDialPlanIdParameter>] [-SendModerationNotifications <Never | Internal | Always>] [-SharingPolicy <SharingPolicyIdParameter>] [-SimpleDisplayName <String>] [-SingleItemRecoveryEnabled <$true | $false>] [-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 | TOU_Signed | FederatedUser | Partner_Managed | MasteredOnPremise | ResourceMailbox | ExcludedFromBackSync | UMFeatureRestricted | RichCoexistence | OrganizationCapabilityUMGrammar | OrganizationCapabilityUMDataStorage | OrganizationCapabilityOABGen | OrganizationCapabilityGMGen | OrganizationCapabilityClientExtensions | BEVDirLockdown | OrganizationCapabilityUMGrammarReady | OrganizationCapabilityMailRouting | OrganizationCapabilityManagement | OrganizationCapabilityTenantUpgrade | OrganizationCapabilityScaleOut | OrganizationCapabilityMessageTracking | OrganizationCapabilityPstProvider | OrganizationCapabilitySuiteServiceStorage>] [-StartDateForRetentionHold <DateTime>] [-SuiteServiceStorage <$true | $false>] [-TenantUpgrade <$true | $false>] [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] [-Type <Regular | Room | Equipment | Shared>] [-UMDataStorage <$true | $false>] [-UMDtmfMap <MultiValuedProperty>] [-UMGrammar <$true | $false>] [-UsageLocation <CountryInfo>] [-UseDatabaseQuotaDefaults <$true | $false>] [-UseDatabaseRetentionDefaults <$true | $false>] [-UserCertificate <MultiValuedProperty>] [-UserPrincipalName <String>] [-UserSMimeCertificate <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]] [-WindowsEmailAddress <SmtpAddress>] [-WindowsLiveID <SmtpAddress>]

This example delivers John Woods's email messages to John's mailbox and also forwards them to Manuel Oliveira's (manuel@contoso.com) mailbox.

Set-Mailbox -Identity John -DeliverToMailboxAndForward $true -ForwardingSMTPAddress manuel@contoso.com 

This example uses the Get-Mailbox command to find all the mailboxes in the Marketing organizational unit, and then uses the Set-Mailbox command to configure these mailboxes. The custom warning, prohibit send, and prohibit send and receive limits are set to 200 megabytes (MB), 250 MB, and 280 MB respectively, and the mailbox database's default limits are ignored. This command can be used to configure a specific set of mailboxes to have larger or smaller limits than other mailboxes in the organization.

Get-Mailbox -OrganizationalUnit "Marketing" | Set-Mailbox -IssueWarningQuota 209715200 -ProhibitSendQuota 262144000 -ProhibitSendReceiveQuota 293601280 -UseDatabaseQuotaDefaults $false 

This example uses the Get-User command to find all users in the Customer Service department, and then uses the Set-Mailbox command to change the maximum message size for sending messages to 2 MB.

Get-User -Filter "Department -eq 'Customer Service'" | Set-Mailbox -MaxSendSize 2097152

This example sets the MailTip translation in French and Chinese.

Set-Mailbox John@contoso.com -MailTipTranslations ("FR: C'est la langue française", "CHT: 這是漢語語言")

This example resets the password for Florence Flipo's mailbox. The next time she signs in to her mailbox, she'll have to reset the new password.

Set-Mailbox florencef -Password (ConvertTo-SecureString -String 'P@$$w0rd1' -AsPlainText -Force) -OldPassword (ConvertTo-SecureString -String 'Pa$$word1' -AsPlainText -Force) -ResetPasswordOnNextLogon $true

This example removes the message tracking organization capability from the arbitration mailbox named SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c} and assigns it to an arbitration mailbox named SystemMailbox{1f05a927-b864-48a7-984d-95b1adfbfe2d}.

Set-Mailbox -Arbitration -Identity "SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}" -MessageTracking $false
Set-Mailbox -Arbitration -Identity "SystemMailbox{1f05a927-b864-48a7-984d-95b1adfbfe2d}" -MessageTracking $true

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

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the mailbox.

This parameter accepts the following values:

  • Alias

    Example: JPhillips

  • Canonical DN

    Example: Atlanta.Corp.Contoso.Com/Users/JPhillips

  • Display Name

    Example: Jeff Phillips

  • Distinguished Name (DN)

    Example: CN=JPhillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com

  • Domain\Account

    Example: Atlanta\JPhillips

  • GUID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2

  • Immutable ID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2@contoso.com

  • Legacy Exchange DN

    Example: /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhillips

  • SMTP Address

    Example: Jeff.Phillips@contoso.com

  • User Principal Name

    Example: JPhillips@contoso.com

AcceptMessagesOnlyFrom

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AcceptMessagesOnlyFrom parameter specifies the mailbox users, mail users, and mail contacts that can send email messages to this mailbox. You can also specify Exchange as a valid recipient for this parameter. If you configure a mailbox to accept messages only from the Exchange recipient, the mailbox receives only system-generated messages.

You can use any of the following values for the valid senders:

  • DN

  • Canonical name

  • GUID

  • Name

  • Display name

  • Alias

  • Exchange DN

  • Primary SMTP email address

By default, this parameter is blank, which enables the mailbox to accept messages from all senders.

AcceptMessagesOnlyFromDLMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AcceptMessagesOnlyFromDLMembers parameter specifies the distribution groups whose members are allowed to send email messages to this mailbox. You can use any of the following values for the allowed distribution groups:

  • DN

  • Canonical name

  • GUID

  • Name

  • Display name

  • LegacyExchangeDN

  • Primary SMTP email address.

By default, this parameter is blank, which enables the mailbox to accept messages from all senders.

AcceptMessagesOnlyFromSendersOrMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AcceptMessagesOnlyFromSendersOrMembers parameter specifies the recipients who can send email messages to this mailbox. You can specify users, contacts, or distribution groups. If you specify a distribution group, messages are accepted from all recipients that are members of that distribution group. You can also specify Exchange as a valid recipient for this parameter. If you configure a distribution group to accept messages only from the Exchange recipient, the distribution group only receives system-generated messages.

You can use any of the following values for the valid senders:

  • DN

  • Canonical name

  • GUID

  • Name

  • Display name

  • Alias

  • Exchange DN

  • Primary SMTP email address

By default, the value of this parameter is blank, which enables the distribution group to accept messages from all senders.

AddOnSKUCapability

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is reserved for internal Microsoft use.

AddressBookPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.AddressBookMailboxPolicyIdParameter

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

Alias

Optional

System.String

The Alias parameter specifies the alias (mail nickname) of the user. The alias can be a combination of characters separated by a period with no intervening spaces. Don't use special characters in the alias.

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 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. This parameter modifies the mandatory properties of a mailbox in this state to correct the problem and remove the legacyMailbox tag from the mailbox.

Arbitration

Optional

System.Management.Automation.SwitchParameter

The Arbitration parameter specifies that the mailbox for which you are executing the command is an arbitration mailbox. Arbitration mailboxes are used for managing approval workflow. For example, an arbitration mailbox is used for handling moderated recipients and distribution group membership approval.

ArbitrationMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The ArbitrationMailbox parameter specifies the mailbox used to manage the moderation process.

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

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

NoteNote:
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

  • Move

  • MoveToDeletedItems

  • SoftDelete

  • HardDelete

  • FolderBind

  • SendAs

  • SendOnBehalf

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

NoteNote:
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

This parameter is available in on-premises Exchange. It isn't available in Exchange Online.

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.

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

BypassLiveId

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

BypassModerationFromSendersOrMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The BypassModerationFromSendersOrMembers parameter specifies the recipients whose messages bypass moderation when sending to this mailbox. You can use any of the following values:

  • DN

  • Canonical name

  • GUID

  • Name

  • Display name

  • LegacyExchangeDN

  • Primary SMTP email address.

By default, this parameter is blank, which ensures that all messages are moderated when this mailbox is configured for moderation.

Senders designated as moderators for this mailbox are never moderated.

CalendarLoggingQuota

Optional

Microsoft.Exchange.Data.Unlimited

The CalendarLoggingQuota parameter specifies the quota in the Recoverable Items folder that's used to store logs generated when changes are made to a calendar item. When the mailbox exceeds this quota, calendar logging is disabled until the Messaging records management feature removes older calendar logs to free more space.

The default quota size is 6 GB.

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.

ClientExtensions

Optional

System.Boolean

The ClientExtensions parameter specifies whether the organization-wide client extensions (also called Apps for Outlook) will be installed in the specified arbitration mailbox. Only one arbitration mailbox (also called the organization mailbox) in the organization can be configured to store client extensions.

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

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.

CreateDTMFMap

Optional

System.Boolean

The CreateDTMFMap parameter specifies that a dual tone multi-frequency (DTMF) map be created for the user.

CustomAttribute1

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute10

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute11

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute12

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute13

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute14

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute15

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute2

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute3

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute4

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute5

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute6

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute7

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute8

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute9

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

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

DefaultPublicFolderMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

The DefaultPublicFolderMailbox parameter assigns a specific public folder mailbox to the user. By default, the public folder mailbox used by a user is automatically selected by an algorithm that load-balances users across all pubic folder mailboxes.

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.

DumpsterMessagesPerFolderCountReceiveQuota

Optional

System.Int32

The DumpsterMessagesPerFolderCountReceiveQuota parameter specifies the maximum number of messages that can be contained in each folder in the Recoverable Items folder (called the dumpster in previous versions of Exchange). When a folder exceeds this limit, it can’t store new messages. For example, if the Deletions folder in the Recoverable Items folder has exceeded the message count limit and the mailbox owner attempts to permanently delete items from their mailbox, the deletion will fail.

DumpsterMessagesPerFolderCountWarningQuota

Optional

System.Int32

The DumpsterMessagesPerFolderCountWarningQuota parameters specifies the number of messages that each folder in the Recoverable Items folder (called the dumpster in previous versions of Exchange) can hold before Exchange sends a warning message to the mailbox owner and logs an event to the application event log. When this quota is reached, warning messages and logged events occur once a day.

EmailAddresses

Optional

Microsoft.Exchange.Data.ProxyAddressCollection

The EmailAddresses parameter specifies all the proxy addresses of the mailbox. It includes the primary SMTP address as one of the proxy addresses.

If you use this parameter, you can't use the PrimarySmtpAddress parameter.

ImportantImportant:
Exchange doesn't validate custom addresses for proper formatting. You must ensure that the custom address you specify complies with the format requirements for that address type. Because X.400 addresses are considered custom addresses in Exchange, they also aren't validated, and you must provide the correct syntax when specifying an X.400 address.

EmailAddressPolicyEnabled

Optional

System.Boolean

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

EnableRoomMailboxAccount

Optional

System.Boolean

Use the EnableRoomMailboxAccount parameter to enable or disable the Active Directory user account that corresponds to a room mailbox. Use the $true value to enable the user account or use $false to disable a logon-enabled user account. To logon-enable a user account, you also have to use the RoomMailboxPassword parameter to specify a password for the user account.

Logon-enabled Active Directory user accounts for room mailboxes are required for solutions such as the Lync Room System. In Exchange Online, a logon-enabled room mailbox doesn't require a license.

ImportantImportant:
After configuring a logon-enabled room mailbox using the EnableRoomMailboxAccount and RoomMailboxPassword parameters in an on-premises Exchange organization, you have to enable the corresponding user account in Active Directory Users and Computers or by running the Enable-ADAccount cmdlet in Windows PowerShell.

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.

EvictLiveId

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

ExtensionCustomAttribute1

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute2

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute3

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute4

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute5

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

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

FederatedIdentity

Optional

System.String

This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments.

The FederatedIdentity parameter associates an on-premises Active Directory user with a Microsoft Office user.

FolderHierarchyChildrenCountReceiveQuota

Optional

System.Int32

The FolderHierarchyChildrenCountReceiveQuota parameter specifies the maximum number of subfolders that can be created in a mailbox folder. The mailbox owner won’t be able to create a new subfolder when this limit is reached.

FolderHierarchyChildrenCountWarningQuota

Optional

System.Int32

The FolderHierarchyChildrenCountWarningQuota parameter specifies the number of subfolders that can be created in a mailbox folder before Exchange sends a warning message to the mailbox owner and logs an event to the application event log. When this quota is reached, warning messages and logged events occur once a day.

FolderHierarchyDepthReceiveQuota

Optional

System.Int32

The FolderHierarchyDepthReceiveQuota parameter specifies the maximum number of levels in the folder hierarchy of a mailbox folder. The mailbox owner won’t be able to create another level in the folder hierarchy of the mailbox folder when this limit is reached.

FolderHierarchyDepthWarningQuota

Optional

System.Int32

The FolderHierarchyDepthWarningQuota parameter specifies the number of levels in the folder hierarchy of a mailbox folder that can be created before Exchange sends a warning message to the mailbox owner and logs an event to the application event log. When this quota is reached, warning messages and logged events occur once a day.

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress the warning or confirmation messages that appear during specific configuration changes.

ForwardingAddress

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

The ForwardingAddress parameter specifies a forwarding address.

ForwardingSmtpAddress

Optional

Microsoft.Exchange.Data.ProxyAddress

The ForwardingSmtpAddress parameter specifies a forwarding SMTP address.

GMGen

Optional

System.Boolean

The GMGen parameter specifies the arbitration mailbox (also called the organization mailbox) for group metrics generation for the organization. In MailTips, group metrics information is used to indicate the number of recipients a message will be sent to or whether recipients are outside your organization. The two possible values for this parameter are $true or $false.

GrantSendOnBehalfTo

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The GrantSendOnBehalfTo parameter specifies the DN of other mailboxes that can send messages on behalf of this mailbox.

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 alias or GUID, aren't accepted.

ImListMigrationCompleted

Optional

System.Boolean

The ImListMigrationCompleted parameter specifies whether a UM-enabled user's Microsoft Lync 2013 contacts have been successfully moved from their Exchange 2013 mailbox to a Lync 2013 server. This indicates the mailbox can be safely migrated from Exchange 2013 back to Exchange 2010 or Exchange 2007. The value $false indicates that the user's Lync contacts have not been moved. The default value is $false.

Lync 2013 supports storing the user's Lync contacts in their Exchange 2013 mailbox. This feature is known as the unified contact store. Exchange 2010 and Exchange 2007 don't support the unified contact store. Before you migrate a user's Exchange 2013 mailbox back to Exchange 2010 or Exchange 2007, the Lync administrator needs to move the user's Lync contacts from the unified contact store back to a Lync 2013 server.

NoteNote:
You shouldn't migrate a mailbox back to Exchange 2010 or Exchange 2007 while the user's Lync contacts are stored in the unified contact store. If you do, the user could permanently lose access to their Lync contacts. After you contact the Lync administrator and verify that the user's Lync contacts have been moved back to the Lync server, you should be able to complete the migration. If you need to migrate the mailbox despite the potential data loss, you can set the ImListMigrationCompleted parameter to $false.

ImmutableId

Optional

System.String

The ImmutableId parameter is used by Outlook Live Directory Sync (OLSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox that's 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 will create 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 must set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into off-premises mailboxes 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-premise Exchange deployment scenario.

IsExcludedFromServingHierarchy

Optional

System.Boolean

The IsExcludedFromServingHierarchy parameter prevents users from accessing the public folder hierarchy on the specified 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.

NoteNote:
This parameter should only be used during public folder migrations. Do not use this parameter once the initial migration validation is complete.

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, that mailbox setting overrides the value set for this attribute on the mailbox database.

JournalArchiveAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

This parameter is reserved for internal Microsoft use.

Languages

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The Languages parameter specifies the language preferences for this mailbox, in order of preference. Several Exchange components display information to a mailbox user in the preferred language, if that language is supported. Some of those components include quota messages, non-delivery reports (NDRs), the Outlook Web App user interface, and Unified Messaging (UM) voice prompts.

LinkedCredential

Optional

System.Management.Automation.PSCredential

The LinkedCredential parameter specifies credentials to use to access the domain controller specified by the LinkedDomainController parameter.

LinkedDomainController

Optional

System.String

The LinkedDomainController parameter specifies the domain controller in the forest where the user account resides, if this 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.

LinkedMasterAccount

Optional

Microsoft.Exchange.Configuration.Tasks.UserIdParameter

The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if this mailbox is a linked mailbox. The master account is the account to which the mailbox links. The master account grants access to the mailbox. You can use one of the following values:

  • GUID

  • DN

  • Domain\Account

  • User principal name (UPN)

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

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.

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

LitigationHoldDuration

Optional

Microsoft.Exchange.Data.Unlimited

The LitigationHoldDuration parameter specifies how long the mailbox will be on litigation hold. Use days to specify the duration.

TipTip:
You have to use the IncludeLitigationHoldDuration parameter with the Get-Mailbox cmdlet to view the value of the litigation-hold duration.

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 and reporting purposes.

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

MailboxMessagesPerFolderCountReceiveQuota

Optional

System.Int32

The MailboxMessagesPerFolderCountReceiveQuota parameter specifies the maximum number of messages for a mailbox folder. When this limit is reached, the folder can’t receive new messages.

MailboxMessagesPerFolderCountWarningQuota

Optional

System.Int32

The MailboxMessagesPerFolderCountWarningQuota parameter specifies the number of messages that a mailbox folder can hold before Exchange sends a warning message to the mailbox owner and logs an event to the application event log. When this quota is reached, warning messages and logged events occur once a day.

MailboxPlan

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPlanIdParameter

This parameter is reserved for internal Microsoft use.

MailRouting

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

MailTip

Optional

System.String

The MailTip parameter specifies the message displayed to senders when they start drafting an email message to this recipient. The MailTip parameter message must be less than or equal to 250 characters.

MailTipTranslations

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The MailTipTranslations parameter specifies additional languages when you want to provide the MailTip parameter information for this recipient in multiple languages. For each language, you must provide the locale, followed by a colon and the specific MailTip parameter message in that language. Each MailTip parameter message must be less than or equal to 250 characters. Multiple languages can be separated by commas.

ManagedFolderMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The ManagedFolderMailboxPolicy parameter specifies a managed folder mailbox policy that controls MRM for the mailbox. If the parameter is set to $null, Exchange removes the managed folder mailbox policy from the mailbox but any managed folders in the mailbox remain.

ManagedFolderMailboxPolicyAllowed

Optional

System.Management.Automation.SwitchParameter

The ManagedFolderMailboxPolicyAllowed parameter bypasses the warning that MRM features aren't supported for email clients running 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:
Although Outlook 2003 Service Pack 3 clients are supported, they have limited MRM functionality.

Management

Optional

System.Boolean

The Management parameter specifies the arbitration mailbox (also call an organization mailbox) used to manage mailbox moves and mailbox migrations.

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

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 email rules. This parameter is validated only when the junk email rules are updated using Outlook Web App or 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 email rules. This parameter is only validated when the junk email 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.

MessageTracking

Optional

System.Boolean

The MessageTracking parameter designates the specified arbitration mailbox (also called an organization mailbox) as the anchor mailbox for cross-organizational message tracking scenarios. By default, the message tracking organizational capability is assigned to the arbitration mailbox named SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c}.

Values for this parameter are either $true or $false.

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.

MicrosoftOnlineServicesID

Optional

Microsoft.Exchange.Data.SmtpAddress

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.

ModeratedBy

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ModeratedBy parameter specifies the users who are responsible for moderating the messages sent to this mailbox. To designate more than one user, separate the users with commas.

This parameter is required if you set the ModerationEnabled parameter to $true.

ModerationEnabled

Optional

System.Boolean

The ModerationEnabled parameter specifies whether to enable moderation for the mailbox. To enable moderation, set this parameter to $true. To disable moderation, set this parameter to $false.

The default value is $false.

Name

Optional

System.String

The Name parameter specifies the Name attribute for this mailbox. The Name attribute is used for the common name in Active Directory.

NetID

Optional

Microsoft.Exchange.Data.NetID

This parameter is reserved for internal Microsoft use.

NewPassword

Optional

System.Security.SecureString

The NewPassword parameter is used when an end-user changes their password in Outlook Web App. Administrators use the Password parameter to reset an end-user's password.

OABGen

Optional

System.Boolean

The OABGen parameter specifies the arbitration mailbox (also called an organization mailbox) used for offline address book (OAB) file generation and storage for the organization. OAB requests are sent to the server where this arbitration mailbox is located.

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

Office

Optional

System.String

The Office parameter specifies the Microsoft Office attribute for this mailbox.

OfflineAddressBook

Optional

Microsoft.Exchange.Configuration.Tasks.OfflineAddressBookIdParameter

The OfflineAddressBook parameter specifies the associated OAB.

OldPassword

Optional

System.Security.SecureString

The OldPassword parameter specifies the existing password for a mailbox. You have to include this parameter when using the Set-Mailbox cmdlet to directly change the password for a mailbox. To reset a password without having to specify the old password, you must be assigned the Reset Password role.

OriginalNetID

Optional

Microsoft.Exchange.Data.NetID

This parameter is reserved for internal Microsoft use.

Password

Optional

System.Security.SecureString

The Password parameter resets the password of the user account associated with the cloud-based mailbox. To reset a password without having to include the OldPassword parameter, you must be assigned the Reset Password role.

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The PrimarySmtpAddress parameter specifies the address that external users see when they receive a message from this mailbox.

If you use this parameter, you can't use the EmailAddresses parameter because the EmailAddresses parameter includes the primary SMTP address.

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, that mailbox setting overrides the value set for this 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, that mailbox setting overrides the value set for this attribute on the mailbox database.

PstProvider

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

PublicFolder

Optional

System.Management.Automation.SwitchParameter

The PublicFolder parameter specifies that the mailbox is configured as a public folder mailbox. Public folder mailboxes are specially designed mailboxes to store the hierarchy and content of public folders. This parameter is required to change the mailbox to a public folder mailbox.

QueryBaseDN

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

The QueryBaseDN parameter specifies the distinguished name for an Active Directory subtree as the value of the msExchQueryBaseDN property for the specified mailbox. This property is used by different messaging features. In Outlook Web App, a user can search for mail-enabled objects within the subtree defined by the QueryBaseDN property. For example, a value of "Users" allows the user to search the Users organizational unit. A value of "DC=contoso,DC=com" allows the user to search the entire contoso.com organization.

QueryBaseDNRestrictionEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

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, that mailbox setting overrides the value set for this attribute in the Transport service.

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.

RejectMessagesFrom

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RejectMessagesFrom parameter specifies the recipients from whom messages are rejected.

RejectMessagesFromDLMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RejectMessagesFromDLMembers parameter specifies distribution lists. Messages from any member of these distribution lists are rejected.

RejectMessagesFromSendersOrMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RejectMessagesFromSendersOrMembers parameter specifies the identity of recipients from whom messages are rejected.

You can use any of the following values for the valid senders:

  • DN

  • Canonical name

  • GUID

  • Name

  • Display name

  • Alias

  • Exchange DN

  • Primary SMTP email address

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.

RemoveManagedFolderAndPolicy

Optional

System.Management.Automation.SwitchParameter

The RemoveManagedFolderAndPolicy parameter specifies whether to remove all MRM 1.0 policies and attributes from a mailbox. If you use this parameter, MRM 1.0 policies and MRM 1.0 properties from any managed folders that were created as part of any MRM 1.0 policies are removed. Managed folders that are empty are also removed from the mailbox, and managed folders that contain items are converted to standard folders.

RemovePicture

Optional

System.Management.Automation.SwitchParameter

The RemovePicture switch specifies whether to remove the picture that a user has added to a mailbox. A picture file can be added to the mailbox by using the Import-RecipientDataProperty cmdlet.

RemoveSpokenName

Optional

System.Management.Automation.SwitchParameter

The RemoveSpokenName switch specifies whether to remove the spoken name that a user has added to a mailbox. A sound file can be added to the mailbox by using the Import-RecipientDataProperty cmdlet.

RequireSecretQA

Optional

System.Boolean

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

The ResetPasswordOnNextLogon parameter specifies whether to require users to change their password the next time they sign in to their mailbox. If the ResetPasswordOnNextLogon parameter is set to $true, it requires users to change their password the next time they sign in to their mailbox. Valid input for this parameter is $true or $false.

ResourceCapacity

Optional

System.Int32

The ResourceCapacity parameter specifies capacity, if this mailbox is a resource mailbox.

You must specify a non-negative integer.

ResourceCustom

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ResourceCustom parameter specifies additional information about the resource. You can define custom properties for resource mailboxes using the Set-ResourceConfig command and use this parameter to set those custom properties.

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 that are 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 website 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, see Understanding Management Role Assignment Policies.

RoomMailboxPassword

Optional

System.Security.SecureString

Use the RoomMailboxPassword parameter to specify a password when you’re using the EnableRoomMailboxAccount parameter to enable the Active Directory user account for a room mailbox. Use the following format: -RoomMailboxPassword (ConvertTo-SecureString -String password -AsPlainText -Force). To set the password when enabling the Active Directory user account for a room mailbox, you must be assigned the Reset Password role.

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)

Unqualified values are treated as bytes.

The default value for this parameter is 64 KB. The maximum value is 256 KB.

NoteNote:
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 that are enabled or active can't exceed the value specified for this parameter.

SamAccountName

Optional

System.String

The SamAccountName parameter specifies the user name for earlier operating systems such as Microsoft Windows NT 4.0, Windows 98, Windows 95, and LAN Manager. This parameter is used to support clients and servers running older versions of the operating system. This attribute must be less than 20 characters in length.

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

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 Email folder. You can use the following values:

  • $true

  • $false

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

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

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.

SecondaryAddress

Optional

System.String

The SecondaryAddress parameter specifies the secondary address used by the UM-enabled user.

SecondaryDialPlan

Optional

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address.

SendModerationNotifications

Optional

Microsoft.Exchange.Data.Directory.Recipient.TransportModerationNotificationFlags

The SendModerationNotifications parameter specifies whether status notifications are sent to users when a message they sent to the moderated distribution group is rejected by one of the moderators. You can specify one of the following values:

  • Always

  • Internal

  • Never

Set this parameter to Always if you want notifications to be sent to all senders.

Set this parameter to Internal if you want notifications to be sent to only the senders that are internal to your organization.

Set this parameter to Never to disable all status notifications.

The default value is Never.

SharingPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.SharingPolicyIdParameter

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

SimpleDisplayName

Optional

System.String

The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. This limited set of characters consists of ASCII characters 26 through 126, inclusively.

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.

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.

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.

SuiteServiceStorage

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

TenantUpgrade

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

ThrottlingPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.ThrottlingPolicyIdParameter

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

Type

Optional

Microsoft.Exchange.Management.RecipientTasks.ConvertibleMailboxSubType

The Type parameter specifies the type for the mailbox. You can use the following values:

  • Regular

  • Room

  • Equipment

  • Shared

UMDataStorage

Optional

System.Boolean

The UMDataStorage parameter specifies the arbitration mailbox (also called the organization mailbox) used to store UM call data records and UM custom prompts. This capability can be assigned to only one arbitration mailbox for the organization.

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

UMDtmfMap

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The UMDtmfMap parameter specifies whether you want to create a user-defined DTMF map for the UM-enabled user.

UMGrammar

Optional

System.Boolean

The UMGrammar parameter specifies the arbitration mailbox (also called the organization mailbox) for UM directory speech grammar generation for the organization. UM directory speech grammars will be generated and used on the Mailbox server of this arbitration mailbox. UM directory speech grammars are used in speech-enabled directory search features, such as UM auto attendants.

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

UsageLocation

Optional

Microsoft.Exchange.Data.Directory.CountryInfo

This parameter is reserved for internal Microsoft use.

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

UserPrincipalName

Optional

System.String

The UserPrincipalName parameter specifies the 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 SMIME certificate used to sign a user's email 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.

WindowsEmailAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The WindowsEmailAddress parameter specifies the Windows email address for this mailbox. This address isn't used by Exchange.

WindowsLiveID

Optional

Microsoft.Exchange.Data.SmtpAddress

This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments.

The WindowsLiveID parameter renames the Microsoft account (formerly known as a Windows Live ID) associated with the mailbox.

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.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.