Set Mailbox operation

The Set Mailbox process modifies the settings of an existing mailbox. You can use this cmdlet for one mailbox at a time. The following table describes the input parameters for Set Mailbox process.

 Adapter request parameters for Set Mailbox process

Element

Definition

Required

<Identity>

Identifies the mailbox

You can use the following values:

  • GUID
  • ADObjectID
  • Distinguished name (DN)
  • Domain\Account
  • User principal name (UPN)
  • LegacyExchangeDN
  • SmtpAddress
  • Alias

Yes

<AcceptMessagesOnlyFrom>

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

No

<AcceptMessagesOnlyFromDLMembers>

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

No

<Alias>

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.

No

<AntispamBypassEnabled>

Specifies whether to skip anti-spam processing on this mailbox

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

No

<ApplyMandatoryProperties>

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

No

<CreateDTMFMap>

Specifies that a dual tone multi-frequency (DTMF) map be created for the user

No

<CustomAttribute1>

Specifies the value for the mailbox attribute CustomAttribute1

No

<CustomAttribute10>

Specifies the value for the mailbox attribute CustomAttribute10

No

<CustomAttribute11>

Specifies the value for the mailbox attribute CustomAttribute11

No

<CustomAttribute12>

Specifies the value for the mailbox attribute CustomAttribute12

No

<CustomAttribute13>

Specifies the value for the mailbox attribute CustomAttribute13

No

<CustomAttribute14>

Specifies the value for the mailbox attribute CustomAttribute14

No

<CustomAttribute15>

Specifies the value for the mailbox attribute CustomAttribute15

No

<CustomAttribute2>

Specifies the value for the mailbox attribute CustomAttribute2

No

<CustomAttribute3>

Specifies the value for the mailbox attribute CustomAttribute3

No

<CustomAttribute4>

Specifies the value for the mailbox attribute CustomAttribute4

No

<CustomAttribute5>

Specifies the value for the mailbox attribute CustomAttribute5

No

<CustomAttribute6>

Specifies the value for the mailbox attribute CustomAttribute6

No

<CustomAttribute7>

Specifies the value for the mailbox attribute CustomAttribute7

No

<CustomAttribute8>

Specifies the value for the mailbox attribute CustomAttribute8

No

<CustomAttribute9>

Specifies the value for the mailbox attribute CustomAttribute9

No

<DeliverToMailboxAndForward>

Specifies whether messages sent to this mailbox will be forwarded to another address. The two possible values for this parameter are $true or $false.

No

<DisplayName>

Specifies the display name for the user account associated with this mailbox

The display name is used by Microsoft Outlook.

No

<DomainController>

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.

No

{{<DowngradeHighPriorityMessagesEnabled

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.

No

<EmailAddresses>

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.

No

<EmailAddressPolicyEnabled>

Specifies whether the e-mail address policy for this mailbox is enabled

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

No

<EndDateForRetentionHold>

Specifies the end date for retention hold for messaging records management (MRM)

To use this parameter, the RetentionHoldEnabled parameter must be set to $true.

No

{{<Extensions

Specifies one or more extension numbers for the user

When the parameter is set, all extension numbers within the dial plan must be unique.

No

<ExternalOofOptions>

Specifies the option for sending an Out of Office message to external senders

You can use the following values:

  • External
  • InternalOnly

No

<ForwardingAddress>

Specifies a forwarding address

If DeliverToMailboxAndForward is set to $true, messages that are sent to this mailbox will be forwarded to the address specified.

No

{{<GrantSendOnBehalfTo

Specifies the distinguished name (DN) of other mailboxes that can send messages on behalf of this mailbox

No

<HiddenFromAddressListsEnabled>

Specifies whether this mailbox is hidden from other address lists

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

No

<IgnoreDefaultScope>

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.

No

<Instance>

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.

No

<IssueWarningQuota>

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.

No

<Languages>

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.

No

<LinkedDomainController>

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.

No

<LinkedMasterAccount>

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

No

<ManagedFolderMailboxPolicy>

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.

No

<ManagedFolderMailboxPolicyAllowed>

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.

No

<MaxBlockedSenders>

Specifies the maximum number of senders that can be included in the blocked senders list

Blocked senders are senders that are considered junk senders by the mailbox user and are used in junk e-mail rules. This parameter is only validated when the junk e-mail rules are updated using Outlook Web Access or Web services.

No

<MaxReceiveSize>

Specifies the maximum size of messages that this mailbox can receive

You must specify either an integer or "unlimited."

No

<MaxSafeSenders>

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.

No

<MaxSendSize>

Specifies the maximum size of messages that this mailbox can send

You must specify either an integer or "unlimited."

No

{{<Name

Specifies the Name attribute for this mailbox

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

No

{{<Office

Specifies the Microsoft Office attribute for this mailbox

No

<OfflineAddressBook>

Specifies the associated address book

No

<PrimarySmtpAddress>

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.

No

<ProhibitSendQuota>

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.

No

<ProhibitSendReceiveQuota>

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.

No

<RecipientLimits>

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.

No

<RejectMessagesFrom>

Specifies the recipients from whom messages will be rejected

No

<RejectMessagesFromDLMembers>

Specifies distribution lists Messages from any member of these distribution lists will be rejected.

No

<RemoveManagedFolderAndPolicy>

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

No

<RequireSenderAuthenticationEnabled>

Specifies whether senders must be authenticated

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

No

<ResourceCapacity>

Specifies capacity, if this mailbox is a resource mailbox

You must specify a non-negative integer.

No

<ResourceCustom>

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.

No

<RetainDeletedItemsFor>

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.

No

<RetainDeletedItemsUntilBackup>

Specifies whether to retain deleted items until the next backup

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

No

<RetentionHoldEnabled>

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.

No

<RulesQuota>

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.

No

<SamAccountName>

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.

No

<SCLDeleteEnabled>

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

No

<SCLDeleteThreshold>

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.

No

<SCLJunkEnabled>

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

No

<SCLJunkThreshold>

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.

No

<SCLQuarantineEnabled>

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

No

<SCLQuarantineThreshold>

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.

No

<SCLRejectEnabled>

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

No

<SCLRejectThreshold>

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.

No

<SecondaryAddress>

Specifies the secondary address that is used by the UM-enabled user

No

<SecondaryDialPlan>

Specifies a secondary UM dial plan to use

This parameter is provided to create a secondary proxy address.

No

<SimpleDisplayName>

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.

No

<StartDateForRetentionHold>

Specifies the start date for retention hold for MRM

To use this parameter, the RetentionHoldEnabled parameter must be set to $true.

No

<Type>

Specifies the type for the mailbox

You can use the following values:

  • Regular
  • Room
  • Equipment
  • Shared

No

<UMDtmfMap>

Specifies if you want to create a user-defined DTMF map for the UM-enabled user

No

<UseDatabaseQuotaDefaults>

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

No

<UseDatabaseRetentionDefaults>

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.

No

<UserPrincipalName>

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.

No

<WindowsEmailAddress>

Specifies the Windows e-mail address for this mailbox

This address is not used by Exchange.

No

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*