Set-Mailbox: Exchange 2010 Help

Set-Mailbox

[This topic's current status is: Content Complete.]

Applies to: Exchange Server 2010 Topic Last Modified: 2010-01-26

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[]>] [-AcceptMessagesOnlyFromSendersOrMembers <RecipientIdParameter[]>] [-Alias <String>] [-AntispamBypassEnabled <$true | $false>] [-ApplyMandatoryProperties <SwitchParameter>] [-Arbitration <SwitchParameter>] [-ArbitrationMailbox <MailboxIdParameter>] [-ArchiveName <MultiValuedProperty>] [-ArchiveQuota <Unlimited>] [-ArchiveWarningQuota <Unlimited>] [-BypassModerationFromSendersOrMembers <RecipientIdParameter[]>] [-CalendarRepairDisabled <$true | $false>] [-CalendarVersionStoreDisabled <$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>] [-DeliverToMailboxAndForward <$true | $false>] [-DisplayName <String>] [-DomainController <Fqdn>] [-DowngradeHighPriorityMessagesEnabled <$true | $false>] [-EmailAddresses <ProxyAddressCollection>] [-EmailAddressPolicyEnabled <$true | $false>] [-EndDateForRetentionHold <Nullable>] [-ExternalOofOptions <InternalOnly | External>] [-Force <SwitchParameter>] [-ForwardingAddress <RecipientIdParameter>] [-GrantSendOnBehalfTo <MailboxOrMailUserOrMailContactIdParameter[]>] [-HiddenFromAddressListsEnabled <$true | $false>] [-IgnoreDefaultScope <SwitchParameter>] [-IssueWarningQuota <Unlimited>] [-Languages <MultiValuedProperty>] [-LinkedCredential <PSCredential>] [-LinkedDomainController <String>] [-LinkedMasterAccount <UserIdParameter>] [-LitigationHoldEnabled <$true | $false>] [-MailboxPlan <MailboxPlanIdParameter>] [-MailTip <String>] [-MailTipTranslations <MultiValuedProperty>] [-ManagedFolderMailboxPolicy <MailboxPolicyIdParameter>] [-ManagedFolderMailboxPolicyAllowed <SwitchParameter>] [-MaxBlockedSenders <Nullable>] [-MaxReceiveSize <Unlimited>] [-MaxSafeSenders <Nullable>] [-MaxSendSize <Unlimited>] [-MessageTrackingReadStatusEnabled <$true | $false>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Name <String>] [-Office <String>] [-OfflineAddressBook <OfflineAddressBookIdParameter>] [-Password <SecureString>] [-Pop3AggregationEnabled <$true | $false>] [-PrimarySmtpAddress <SmtpAddress>] [-ProhibitSendQuota <Unlimited>] [-ProhibitSendReceiveQuota <Unlimited>] [-QueryBaseDNRestrictionEnabled <$true | $false>] [-RecipientLimits <Unlimited>] [-RecoverableItemsQuota <Unlimited>] [-RecoverableItemsWarningQuota <Unlimited>] [-RejectMessagesFrom <RecipientIdParameter[]>] [-RejectMessagesFromDLMembers <RecipientIdParameter[]>] [-RejectMessagesFromSendersOrMembers <RecipientIdParameter[]>] [-RemoteAccountPolicy <RemoteAccountPolicyIdParameter>] [-RemoveManagedFolderAndPolicy <SwitchParameter>] [-RemovePicture <SwitchParameter>] [-RemoveSpokenName <SwitchParameter>] [-RequireSecretQA <$true | $false>] [-RequireSenderAuthenticationEnabled <$true | $false>] [-ResetPasswordOnNextLogon <$true | $false>] [-ResourceCapacity <Nullable>] [-ResourceCustom <MultiValuedProperty>] [-RetainDeletedItemsFor <EnhancedTimeSpan>] [-RetainDeletedItemsUntilBackup <$true | $false>] [-RetentionComment <String>] [-RetentionHoldEnabled <$true | $false>] [-RetentionPolicy <MailboxPolicyIdParameter>] [-RetentionUrl <String>] [-RoleAssignmentPolicy <MailboxPolicyIdParameter>] [-RssAggregationEnabled <$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>] [-SendModerationNotifications <Never | Internal | Always>] [-SharingPolicy <SharingPolicyIdParameter>] [-SimpleDisplayName <String>] [-SingleItemRecoveryEnabled <$true | $false>] [-StartDateForRetentionHold <Nullable>] [-ThrottlingPolicy <ThrottlingPolicyIdParameter>] [-Type <Regular | Room | Equipment | Shared>] [-UMDtmfMap <MultiValuedProperty>] [-UseDatabaseQuotaDefaults <Nullable>] [-UseDatabaseRetentionDefaults <$true | $false>] [-UserCertificate <MultiValuedProperty>] [-UserPrincipalName <String>] [-UserSMimeCertificate <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]] [-WindowsEmailAddress <SmtpAddress>] [-WindowsLiveID <SmtpAddress>]

Parameters

Parameter	Required	Type	Description
Identity	Required	Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter	The Identity parameter specifies the mailbox. You can use the following values: ADObjectID Alias Distinguished name (DN) Domain\Account GUID LegacyExchangeDN SmtpAddress User principal name (UPN)
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, 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 e-mail address By default, this parameter is blank, which 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: DN Canonical name GUID Name Display name LegacyExchangeDN Primary SMTP e-mail address. By default, this parameter is blank, which enables the mailbox to accept messages from all senders.
AcceptMessagesOnlyFromSendersOrMembers	Optional	Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]	The AcceptMessagesOnlyFromSendersOrMembers parameter specifies the recipients who can send e-mail 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 e-mail address By default, the value of this parameter is blank, which enables the distribution group 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. 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 Server 2003 extensions to the Active Directory Users and Computers console isn't supported. If a mailbox is created with this tool, it's identified as a legacy mailbox, even though it resides on a server running Microsoft Exchange Server 2010. This parameter modifies the mandatory properties of a mailbox in this state to correct the problem and remove the legacyMailbox tag from the mailbox
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.
ArchiveName	Optional	Microsoft.Exchange.Data.MultiValuedProperty	The ArchiveName parameter specifies the name of the archive mailbox. Use this parameter to change the name of the archive.
ArchiveQuota	Optional	Microsoft.Exchange.Data.Unlimited	The ArchiveQuota parameter specifies the archive mailbox size at which it no longer accepts messages. 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.
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.
BypassModerationFromSendersOrMembers	Optional	Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]	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 e-mail 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.
CalendarRepairDisabled	Optional	System.Boolean	The CalendarRepairDisabled parameter specifies that this mailbox won't have its calendar items repaired by the Calendar Repair Assistant. The two possible values for this parameter are `$true` or `$false`. The default is `$false`.
CalendarVersionStoreDisabled	Optional	System.Boolean	The CalendarVersionStoreDisabled parameter specifies that calendar changes in a user's mailbox aren't logged. The two possible values for this parameter are `$true` or `$false`. The default value is `$false`. By default, all changes to a calendar item are recorded in the mailbox of a user to keep older versions of meeting items.
Confirm	Optional	System.Management.Automation.SwitchParameter	The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.
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 Server name\database name If you don't specify the server name, the command searches for the database on the local server.
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.
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. Important: 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 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`.
ExternalOofOptions	Optional	Microsoft.Exchange.Data.Directory.Recipient.ExternalOofOptions	The ExternalOofOptions parameter specifies the option for sending an Out of Office message to external senders. You can use the following values: `External` `InternalOnly`
Force	Optional	System.Management.Automation.SwitchParameter	The Force switch specifies whether to suppress 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.
GrantSendOnBehalfTo	Optional	Microsoft.Exchange.Configuration.Tasks.MailboxOrMailUserOrMailContactIdParameter[]	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.
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.
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 Microsoft Office 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 LegacyExchangeDN SmtpAddress Alias
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.
MailboxPlan	Optional	Microsoft.Exchange.Configuration.Tasks.MailboxPlanIdParameter	This parameter is available only in the Outlook Live service. The MailboxPlan parameter specifies a mailbox plan for the mailbox.
MailTip	Optional	System.String	The MailTip parameter specifies the message displayed to senders when they start drafting an e-mail 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 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 the ManagedFolderMailboxPolicyAllowed parameter is used. Note: Although Outlook 2003 Service Pack 3 clients are supported, they have limited MRM functionality.
MaxBlockedSenders	Optional	System.Nullable	The MaxBlockedSenders parameter specifies the maximum number of senders that can be included in the blocked senders list. Blocked senders are senders that are considered junk senders by the mailbox user and are used in junk e-mail rules. This parameter is validated only when the junk e-mail rules are updated using Outlook Web App or 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	The MaxSafeSenders parameter specifies the maximum number of senders that can be included in the safe senders list. Safe senders are senders that are trusted by the mailbox user and are used in junk e-mail rules. This parameter is only validated when the junk e-mail rules are updated using Outlook Web App 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`.
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`.
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.
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 offline address book (OAB).
Password	Optional	System.Security.SecureString	This parameter is available only in the Outlook Live service. The Password parameter resets the password of the Windows Live ID associated with the mailbox.
Pop3AggregationEnabled	Optional	System.Boolean	The Pop3AggregationEnabled parameter isn't available in this release.
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.
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 on the Hub Transport server.
RecoverableItemsQuota	Optional	Microsoft.Exchange.Data.Unlimited	The RecoverableItemsQuota parameter specifies the limit for the Recovery Items folder. When you reach the quota limit, you can't put any more items in the Recovery Items folder.
RecoverableItemsWarningQuota	Optional	Microsoft.Exchange.Data.Unlimited	The RecoverableItemsWarningQuota parameter specifies the quota for when a warning event is entered in Event Viewer.
RejectMessagesFrom	Optional	Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]	The RejectMessagesFrom parameter specifies the recipients from whom messages are rejected.
RejectMessagesFromDLMembers	Optional	Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]	The RejectMessagesFromDLMembers parameter specifies distribution lists. Messages from any member of these distribution lists are rejected.
RejectMessagesFromSendersOrMembers	Optional	Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]	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 e-mail address
RemoteAccountPolicy	Optional	Microsoft.Exchange.Configuration.Tasks.RemoteAccountPolicyIdParameter	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	This parameter is available only in the Outlook Live service. If the ResetPasswordOnNextLogon parameter is set to `$true`, it requires users to change their Windows Live ID password the next time they sign in to their Outlook Live mailbox. Valid input for this parameter is `$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`.
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 Web site for the company.
RoleAssignmentPolicy	Optional	Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter	The RoleAssignmentPolicy parameter specifies the management role assignment policy to assign to the mailbox when it's created or enabled. If you don't include this parameter when you create or enable a mailbox, the default assignment policy is used. If the assignment policy name contains spaces, enclose the name in quotation marks ("). If you don't want to assign an assignment policy when a mailbox is created or enabled, specify a value of `$null`. For more information about assignment policies, see Understanding Management Role Assignment Policies.
RssAggregationEnabled	Optional	System.Boolean	The RssAggregationEnabled parameter isn't available in this release.
RulesQuota	Optional	Microsoft.Exchange.Data.ByteQuantifiedSize	The RulesQuota parameter specifies the limit for the size of rules for this mailbox. When you enter a value, qualify the value with one of the following: B (bytes) KB (kilobytes) MB (megabytes) GB (gigabytes) TB (terabytes) Unqualified values are treated as bytes. The default value for this parameter is 64 KB. Note: The quota for mailbox rules applies only to enabled rules. There is no restriction on the number of disabled rules a mailbox can have. However, the total size of rules 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.Nullable	The SCLDeleteEnabled parameter specifies whether messages that meet the spam confidence level (SCL) threshold specified by the SCLDeleteThreshold parameter are deleted. You can use the following values: `$true` `$false` `$null`
SCLDeleteThreshold	Optional	System.Nullable	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.Nullable	The SCLJunkEnabled parameter specifies whether messages that meet the SCL threshold specified by the SCLJunkThreshold parameter are moved to the Junk E-mail folder. You can use the following values: `$true` `$false` `$null`
SCLJunkThreshold	Optional	System.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 from 0 through 9 inclusive.
SCLQuarantineEnabled	Optional	System.Nullable	The SCLQuarantineEnabled parameter specifies whether messages that meet the SCL threshold specified by the SCLQuarantineThreshold parameter are quarantined. If a message is quarantined, it's sent to the quarantine mailbox where the messaging administrator can review it. You can use the following values: `$true` `$false` `$null`
SCLQuarantineThreshold	Optional	System.Nullable	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.Nullable	The SCLRejectEnabled parameter specifies whether messages that meet the SCL threshold specified by the SCLRejectThreshold parameter are rejected. If a message is rejected, it's deleted and a rejection response is sent to the sender. You can use the following values: `$true` `$false` `$null`
SCLRejectThreshold	Optional	System.Nullable	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`.
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`.
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`
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.
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`.
UserCertificate	Optional	Microsoft.Exchange.Data.MultiValuedProperty	The UserCertificate parameter specifies the digital certificate used to sign a user's e-mail messages.
UserPrincipalName	Optional	System.String	The UserPrincipalName parameter specifies the 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 e-mail messages.
WhatIf	Optional	System.Management.Automation.SwitchParameter	The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.
WindowsEmailAddress	Optional	Microsoft.Exchange.Data.SmtpAddress	The WindowsEmailAddress parameter specifies the Windows e-mail address for this mailbox. This address isn't used by Exchange.
WindowsLiveID	Optional	Microsoft.Exchange.Data.SmtpAddress	This parameter is available only in the Outlook Live service. The WindowsLiveID parameter renames the Windows Live ID associated with the mailbox.

Detailed Description

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 Mailbox Permissions topic.

Input Types

Return Types

Errors

Error	Description

Exceptions

Exceptions	Description
>

Examples

EXAMPLE 1

This example forwards John Peoples' e-mail messages to Leonardo Oliveira's (leonardo@contoso.com) mailbox.

Set-Mailbox -Identity John -DeliverToMailboxAndForward $true -ForwardingAddress leonardo@contoso.com

EXAMPLE 2

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

EXAMPLE 3

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

EXAMPLE 4

This example sets the MailTip translation in French and Chinese.

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