Share via

Set-Mailbox

  • Article

 

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

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.

Syntax

set-Mailbox -Identity <MailboxIdParameter> [-AcceptMessagesOnlyFrom <RecipientIdParameter[]>] [-AcceptMessagesOnlyFromDLMembers <RecipientIdParameter[]>] [-Alias <String>] [-AntispamBypassEnabled <$true | $false>] [-ApplyMandatoryProperties <SwitchParameter>] [-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>] [-DeliverToMailboxAndForward <$true | $false>] [-DisplayName <String>] [-DomainController <Fqdn>] [-DowngradeHighPriorityMessagesEnabled <$true | $false>] [-EmailAddresses <ProxyAddressCollection>] [-EmailAddressPolicyEnabled <$true | $false>] [-EndDateForRetentionHold <Nullable>] [-Extensions <MultiValuedProperty>] [-ExternalOofOptions <InternalOnly | External>] [-ForwardingAddress <RecipientIdParameter>] [-GrantSendOnBehalfTo <MailboxOrMailUserIdParameter[]>] [-HiddenFromAddressListsEnabled <$true | $false>] [-IgnoreDefaultScope <SwitchParameter>] [-IssueWarningQuota <Unlimited>] [-Languages <MultiValuedProperty>] [-LinkedCredential <PSCredential>] [-LinkedDomainController <String>] [-LinkedMasterAccount <UserIdParameter>] [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] [-ManagedFolderMailboxPolicyAllowed <SwitchParameter>] [-MaxBlockedSenders <Nullable>] [-MaxReceiveSize <Unlimited>] [-MaxSafeSenders <Nullable>] [-MaxSendSize <Unlimited>] [-Name <String>] [-Office <String>] [-OfflineAddressBook <OfflineAddressBookIdParameter>] [-PrimarySmtpAddress <SmtpAddress>] [-ProhibitSendQuota <Unlimited>] [-ProhibitSendReceiveQuota <Unlimited>] [-RecipientLimits <Unlimited>] [-RejectMessagesFrom <RecipientIdParameter[]>] [-RejectMessagesFromDLMembers <RecipientIdParameter[]>] [-RemoveManagedFolderAndPolicy <SwitchParameter>] [-RequireSenderAuthenticationEnabled <$true | $false>] [-ResourceCapacity <Nullable>] [-ResourceCustom <MultiValuedProperty>] [-RetainDeletedItemsFor <EnhancedTimeSpan>] [-RetainDeletedItemsUntilBackup <$true | $false>] [-RetentionHoldEnabled <$true | $false>] [-RulesQuota <ByteQuantifiedSize>] [-SamAccountName <String>] [-SCLDeleteEnabled <Nullable>] [-SCLDeleteThreshold <Nullable>] [-SCLJunkEnabled <Nullable>] [-SCLJunkThreshold <Nullable>] [-SCLQuarantineEnabled <Nullable>] [-SCLQuarantineThreshold <Nullable>] [-SCLRejectEnabled <Nullable>] [-SCLRejectThreshold <Nullable>] [-SecondaryAddress <String>] [-SecondaryDialPlan <UMDialPlanIdParameter>] [-SimpleDisplayName <String>] [-StartDateForRetentionHold <Nullable>] [-Type <Regular | Room | Equipment | Shared>] [-UMDtmfMap <MultiValuedProperty>] [-UseDatabaseQuotaDefaults <Nullable>] [-UseDatabaseRetentionDefaults <$true | $false>] [-UserPrincipalName <String>] [-UseRusServer <String>] [-WhatIf [<SwitchParameter>]] [-WindowsEmailAddress <SmtpAddress>]

set-Mailbox [-AcceptMessagesOnlyFrom <RecipientIdParameter[]>] [-AcceptMessagesOnlyFromDLMembers <RecipientIdParameter[]>] [-Alias <String>] [-AntispamBypassEnabled <$true | $false>] [-ApplyMandatoryProperties <SwitchParameter>] [-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>] [-DeliverToMailboxAndForward <$true | $false>] [-DisplayName <String>] [-DomainController <Fqdn>] [-DowngradeHighPriorityMessagesEnabled <$true | $false>] [-EmailAddresses <ProxyAddressCollection>] [-EmailAddressPolicyEnabled <$true | $false>] [-EndDateForRetentionHold <Nullable>] [-Extensions <MultiValuedProperty>] [-ExternalOofOptions <InternalOnly | External>] [-ForwardingAddress <RecipientIdParameter>] [-GrantSendOnBehalfTo <MailboxOrMailUserIdParameter[]>] [-HiddenFromAddressListsEnabled <$true | $false>] [-IgnoreDefaultScope <SwitchParameter>] [-Instance <Mailbox>] [-IssueWarningQuota <Unlimited>] [-Languages <MultiValuedProperty>] [-LinkedCredential <PSCredential>] [-LinkedDomainController <String>] [-LinkedMasterAccount <UserIdParameter>] [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] [-ManagedFolderMailboxPolicyAllowed <SwitchParameter>] [-MaxBlockedSenders <Nullable>] [-MaxReceiveSize <Unlimited>] [-MaxSafeSenders <Nullable>] [-MaxSendSize <Unlimited>] [-Name <String>] [-Office <String>] [-OfflineAddressBook <OfflineAddressBookIdParameter>] [-PrimarySmtpAddress <SmtpAddress>] [-ProhibitSendQuota <Unlimited>] [-ProhibitSendReceiveQuota <Unlimited>] [-RecipientLimits <Unlimited>] [-RejectMessagesFrom <RecipientIdParameter[]>] [-RejectMessagesFromDLMembers <RecipientIdParameter[]>] [-RemoveManagedFolderAndPolicy <SwitchParameter>] [-RequireSenderAuthenticationEnabled <$true | $false>] [-ResourceCapacity <Nullable>] [-ResourceCustom <MultiValuedProperty>] [-RetainDeletedItemsFor <EnhancedTimeSpan>] [-RetainDeletedItemsUntilBackup <$true | $false>] [-RetentionHoldEnabled <$true | $false>] [-RulesQuota <ByteQuantifiedSize>] [-SamAccountName <String>] [-SCLDeleteEnabled <Nullable>] [-SCLDeleteThreshold <Nullable>] [-SCLJunkEnabled <Nullable>] [-SCLJunkThreshold <Nullable>] [-SCLQuarantineEnabled <Nullable>] [-SCLQuarantineThreshold <Nullable>] [-SCLRejectEnabled <Nullable>] [-SCLRejectThreshold <Nullable>] [-SecondaryAddress <String>] [-SecondaryDialPlan <UMDialPlanIdParameter>] [-SimpleDisplayName <String>] [-StartDateForRetentionHold <Nullable>] [-Type <Regular | Room | Equipment | Shared>] [-UMDtmfMap <MultiValuedProperty>] [-UseDatabaseQuotaDefaults <Nullable>] [-UseDatabaseRetentionDefaults <$true | $false>] [-UserPrincipalName <String>] [-UseRusServer <String>] [-WhatIf [<SwitchParameter>]] [-WindowsEmailAddress <SmtpAddress>]

Detailed Description

To run the Set-Mailbox cmdlet, the account you use must be delegated the following:

  • Exchange Recipient Administrator role

For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter identifies the mailbox. You can use the following values:

  • GUID

  • ADObjectID

  • Distinguished name (DN)

  • Domain\Account

  • User principal name (UPN)

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

AcceptMessagesOnlyFrom

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The AcceptMessagesOnlyFrom parameter specifies the mailbox users, mail users and mail contacts that can send e-mail 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, it will only receive system-generated messages.

The AcceptMessagesOnlyFrom parameter can take any of the following values for the valid senders:

  • Distinguished name (DN)

  • Canonical name

  • GUID

  • Name

  • Display name

  • Alias

  • Exchange DN

  • Primary SMTP e-mail address

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

AcceptMessagesOnlyFromDLMembers

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

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

  • Distinguished name (DN)

  • Canonical name

  • GUID

  • Name

  • Display name

  • Legacy Exchange DN

  • Primary SMTP e-mail address

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

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

Creating a Exchange 2007 mailbox through the Exchange 2003 extensions to the Active Directory Users and Computers console is not supported. If an Exchange 2007 mailbox is created with this tool, it will be identified as a legacy mailbox, even though it resides on an Exchange 2007 server. Use the ApplyMandatoryProperties parameter to modify the mandatory properties of a mailbox in this state to correct the problem and remove the legacyMailbox tag from the mailbox.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm parameter 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 parameter.

CreateDTMFMap

Optional

System.Boolean

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

CustomAttribute1

Optional

System.String

The CustomAttribute1 parameter specifies the value for the mailbox attribute CustomAttribute1.

CustomAttribute10

Optional

System.String

The CustomAttribute10 parameter specifies the value for the mailbox attribute CustomAttribute10.

CustomAttribute11

Optional

System.String

The CustomAttribute11 parameter specifies the value for the mailbox attribute CustomAttribute11.

CustomAttribute12

Optional

System.String

The CustomAttribute12 parameter specifies the value for the mailbox attribute CustomAttribute12.

CustomAttribute13

Optional

System.String

The CustomAttribute13 parameter specifies the value for the mailbox attribute CustomAttribute13.

CustomAttribute14

Optional

System.String

The CustomAttribute14 parameter specifies the value for the mailbox attribute CustomAttribute14.

CustomAttribute15

Optional

System.String

The CustomAttribute15 parameter specifies the value for the mailbox attribute CustomAttribute15.

CustomAttribute2

Optional

System.String

The CustomAttribute2 parameter specifies the value for the mailbox attribute CustomAttribute2.

CustomAttribute3

Optional

System.String

The CustomAttribute3 parameter specifies the value for the mailbox attribute CustomAttribute3.

CustomAttribute4

Optional

System.String

The CustomAttribute4 parameter specifies the value for the mailbox attribute CustomAttribute4.

CustomAttribute5

Optional

System.String

The CustomAttribute5 parameter specifies the value for the mailbox attribute CustomAttribute5.

CustomAttribute6

Optional

System.String

The CustomAttribute6 parameter specifies the value for the mailbox attribute CustomAttribute6.

CustomAttribute7

Optional

System.String

The CustomAttribute7 parameter specifies the value for the mailbox attribute CustomAttribute7.

CustomAttribute8

Optional

System.String

The CustomAttribute8 parameter specifies the value for the mailbox attribute CustomAttribute8.

CustomAttribute9

Optional

System.String

The CustomAttribute9 parameter specifies the value for the mailbox attribute CustomAttribute9.

DeliverToMailboxAndForward

Optional

System.Boolean

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

If DeliverToMailboxAndForward 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 domain controller to use to write changes to Active Directory. Use the fully qualified domain name (FQDN) of the domain controller that you want to use.

DowngradeHighPriorityMessagesEnabled

Optional

System.Boolean

The DowngradeHighPriorityMessagesEnabled parameter prevents 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.

EmailAddresses

Optional

Microsoft.Exchange.Data.ProxyAddressCollection

The EmailAddresses parameter specifies all the proxy addresses of the mailbox. It includes the primary Simple Mail Transfer Protocol (SMTP) address as one of the proxy addresses.

If you use this parameter, you cannot use the PrimarySMTPAddress parameter.

Important

Exchange 2007 does not validate custom addresses for correct formatting. You must make sure that the custom address that you specify complies with the format requirements for that address type. Because X.400 addresses are considered custom addresses in Exchange 2007, they are also not validated. Therefore, you must provide the correct syntax when you specify an X.400 address.

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

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.

Extensions

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies one or more extension numbers for the user. When the parameter is set, all extension numbers within the dial plan must be unique.

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

ForwardingAddress

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

The ForwardingAddress parameter specifies a forwarding address. If DeliverToMailboxAndForward is set to $true, messages that are sent to this mailbox will be forwarded to the address specified.

GrantSendOnBehalfTo

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

The GrantSendOnBehalfTo parameter specifies the distinguished name (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 and use the entire forest as the scope. This allows the command to access Active Directory objects that are not currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:

  • You cannot use the DomainController parameter. The command will use 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, are not accepted.

Instance

Optional

Microsoft.Exchange.Data.Directory.Management.Mailbox

The Instance parameter enables you to pass an entire object to the command to be processed. It is mainly used in scripts where an entire object must be passed to the command.

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 that is set for this attribute on the mailbox database.

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), Microsoft Outlook Web Access 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 will grant access to the mailbox. You can use one of the following values:

  • GUID

  • Distinguished name (DN)

  • Domain\Account

  • User principal name (UPN)

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

ManagedFolderMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The ManagedFolderMailboxPolicy parameter specifies a managed folder mailbox policy that controls messaging records management (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 messaging records management (MRM) features are not supported for e-mail clients running versions of Outlook earlier than Outlook 2007. When a managed folder mailbox policy is assigned to a mailbox using the ManagedFolderMailboxPolicy parameter, the warning appears by default unless ManagedFolderMailboxPolicyAllowed is used.

Note

Although Outlook 2003 Service Pack 3 (SP3) clients are supported, they have limited MRM functionality.

MaxBlockedSenders

Optional

System.Nullable

Use the MaxBlockedSenders parameter to specify 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 only validated when the junk e-mail rules are updated using Outlook Web Access 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.Nullable

Use the MaxSafeSenders parameter to specify 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 Outlook Web Access or Web 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."

Name

Optional

System.String

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

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

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

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

If you use this parameter, you cannot use the EmailAddresses parameter because EmailAddresses 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 that is 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 that is set for this attribute on the mailbox database.

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 that is set for this attribute on the hub transport server.

RejectMessagesFrom

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The RejectMessagesFrom parameter specifies the recipients from whom messages will be rejected.

RejectMessagesFromDLMembers

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

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

RemoveManagedFolderAndPolicy

Optional

System.Management.Automation.SwitchParameter

In Exchange 2007 Service Pack 1, you can use the RemoveManagedFolderAndPolicy parameter to remove all MRM policies and attributes from a mailbox. If you use this parameter, MRM policies and MRM properties from any managed folders that were created as part of any MRM policies are all removed, managed folders that are empty are removed from the mailbox, and managed folders that contain items are converted to standard folders.

RequireSenderAuthenticationEnabled

Optional

System.Boolean

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

ResourceCapacity

Optional

System.Nullable

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.

RetentionHoldEnabled

Optional

System.Boolean

The RetentionHoldEnabled parameter specifies whether retention hold is enabled for MRM. The two possible values for this parameter are $true or $false. To set the start date for retention hold, use the StartDateForRetentionHold parameter.

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. The maximum value for this parameter is 256 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 that are enabled, or active, cannot exceed the value specified for this parameter.

SamAccountName

Optional

System.String

The SamAccountName parameter specifies the user name for earlier operating systems such as Windows NT 4.0, Windows 98, Windows 95, and LAN Manager. The 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.Nullable

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

  • $true

  • $false

  • $null

SCLDeleteThreshold

Optional

System.Nullable

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

You must specify an integer between 0 and 9 inclusive.

SCLJunkEnabled

Optional

System.Nullable

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

  • $true

  • $false

  • $null

SCLJunkThreshold

Optional

System.Nullable

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 between 0 and 9 inclusive.

SCLQuarantineEnabled

Optional

System.Nullable

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

  • $true

  • $false

  • $null

SCLQuarantineThreshold

Optional

System.Nullable

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

You must specify an integer between 0 and 9 inclusive.

SCLRejectEnabled

Optional

System.Nullable

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

  • $true

  • $false

  • $null

SCLRejectThreshold

Optional

System.Nullable

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

You must specify an integer between 0 and 9 inclusive.

SecondaryAddress

Optional

System.String

This parameter specifies the secondary address that is used by the UM-enabled user.

SecondaryDialPlan

Optional

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

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

SimpleDisplayName

Optional

System.String

The SimpleDisplayName parameter is used on objects where the name of the object may be displayed in an environment that does not support Unicode characters. The only supported characters for the SimpleDisplayName parameter are ASCII characters 26 through 126, inclusively. These characters are the ones that you typically find on most U.S. English keyboards.

StartDateForRetentionHold

Optional

System.Nullable

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

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

UMDtmfMap

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies if you want to create a user-defined DTMF map for the UM-enabled user. 

UseDatabaseQuotaDefaults

Optional

System.Nullable

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.

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.

UseRusServer

Optional

System.String

The UseRusServer parameter instructs the command to use the specified Recipient Update Service server to get and set mailbox and Active Directory user attributes.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, 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 parameter.

WindowsEmailAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The WindowsEmailAddress parameter specifies the Windows e-mail address for this mailbox. This address is not used by Exchange.

Input Types

Return Types

Errors

Error Description

 

Exceptions

Exceptions Description

 

Example

The first example shows how to forward John Peoples' e-mail messages to Jose De Oliveira's (jose@contoso.com) mailbox.

The second example uses the Get-Mailbox command to find all the mailboxes in the Marketing organizational unit (OU) 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.

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

Set-Mailbox -Identity John -DeliverToMailboxAndForward $true -ForwardingAddress jose@contoso.com 
Get-Mailbox -OrganizationalUnit "Marketing" | Set-Mailbox -IssueWarningQuota 209715200 -ProhibitSendQuota 262144000 -ProhibitSendReceiveQuota 293601280 -UseDatabaseQuotaDefaults $false 
Get-User -Filter "Department -eq 'Customer Service'" | Set-Mailbox -MaxSendSize 2097152