Export (0) Print
Expand All

Set-MailUser

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

Use the Set-MailUser cmdlet to modify the mail-related attributes of an existing user in Active Directory.


set-MailUser -Identity <MailUserIdParameter> [-AcceptMessagesOnlyFrom <RecipientIdParameter[]>] [-AcceptMessagesOnlyFromDLMembers <RecipientIdParameter[]>] [-AcceptMessagesOnlyFromSendersOrMembers <RecipientIdParameter[]>] [-Alias <String>] [-ArbitrationMailbox <MailboxIdParameter>] [-BypassModerationFromSendersOrMembers <RecipientIdParameter[]>] [-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>] [-DisplayName <String>] [-DomainController <Fqdn>] [-EmailAddresses <ProxyAddressCollection>] [-EmailAddressPolicyEnabled <$true | $false>] [-ExternalEmailAddress <ProxyAddress>] [-GrantSendOnBehalfTo <MailboxOrMailUserOrMailContactIdParameter[]>] [-HiddenFromAddressListsEnabled <$true | $false>] [-IgnoreDefaultScope <SwitchParameter>] [-MacAttachmentFormat <BinHex | UuEncode | AppleSingle | AppleDouble>] [-MailTip <String>] [-MailTipTranslations <MultiValuedProperty>] [-MaxReceiveSize <Unlimited>] [-MaxSendSize <Unlimited>] [-MessageBodyFormat <Text | Html | TextAndHtml>] [-MessageFormat <Text | Mime>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Name <String>] [-Password <SecureString>] [-PrimarySmtpAddress <SmtpAddress>] [-RecipientLimits <Unlimited>] [-RejectMessagesFrom <RecipientIdParameter[]>] [-RejectMessagesFromDLMembers <RecipientIdParameter[]>] [-RejectMessagesFromSendersOrMembers <RecipientIdParameter[]>] [-RemovePicture <SwitchParameter>] [-RemoveSpokenName <SwitchParameter>] [-RequireSenderAuthenticationEnabled <$true | $false>] [-ResetPasswordOnNextLogon <$true | $false>] [-SamAccountName <String>] [-SecondaryAddress <String>] [-SecondaryDialPlan <UMDialPlanIdParameter>] [-SendModerationNotifications <Never | Internal | Always>] [-SimpleDisplayName <String>] [-UMDtmfMap <MultiValuedProperty>] [-UseMapiRichTextFormat <Never | Always | UseDefaultSettings>] [-UsePreferMessageFormat <$true | $false>] [-UserPrincipalName <String>] [-WhatIf [<SwitchParameter>]] [-WindowsEmailAddress <SmtpAddress>] [-WindowsLiveID <SmtpAddress>]

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailUserIdParameter

The Identity parameter specifies the mail user. You can use one of the following values:

  • ADObjectID
  • GUID
  • Distinguished name (DN)
  • Domain\SamAccountName
  • User principal name (UPN)
  • Legacy DN
  • E-mail address
  • User alias

AcceptMessagesOnlyFrom

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

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

You can use one 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 mail user 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 mail user. 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 mail user to accept messages from all senders.

AcceptMessagesOnlyFromSendersOrMembers

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The AcceptMessagesOnlyFromSendersOrMembers parameter specifies the recipients who are allowed to send e-mail messages to this mail user. You can use any of the following values for the allowed distribution groups:

  • Alias
  • Canonical name
  • Display name
  • DN
  • GUID
  • Name
  • LegacyExchangeDN
  • Primary SMTP e-mail address

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

Alias

Optional

System.String

The Alias parameter specifies the alias of the user. An alias can contain letters, numbers, and the following punctuation marks and symbols:

  • !
  • #
  • $
  • %
  • ^
  • &
  • *
  • +
  • -
  • .
  • /
  • =
  • ?
  • _
  • {
  • }
  • |
  • ~

ArbitrationMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

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

BypassModerationFromSendersOrMembers

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

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

  • Alias
  • Canonical name
  • Display name
  • DN
  • GUID
  • Name
  • LegacyExchangeDN
  • Primary SMTP e-mail address

This default value ensures that all messages are moderated when this mail user is configured for moderation.

Aa995971.note(en-us,EXCHG.140).gifNote:
Senders designated as moderators for this mail user are never moderated.

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.

DisplayName

Optional

System.String

The DisplayName parameter specifies the display name of the user.

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.

EmailAddresses

Optional

Microsoft.Exchange.Data.ProxyAddressCollection

The EmailAddresses parameter specifies the e-mail alias of the mail user. All valid Exchange e-mail address types may be used. You can specify multiple values for the EmailAddresses parameter as a comma-delimited list.

Aa995971.important(en-us,EXCHG.140).gifImportant:
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're also not 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 addresses for the mailbox are automatically updated based on the e-mail address policies defined. When this parameter is set to $true, you can't change the PrimarySmtpAddress or WindowsEmailAddress parameters.

ExternalEmailAddress

Optional

Microsoft.Exchange.Data.ProxyAddress

The ExternalEmailAddress parameter specifies an e-mail address outside the organization. E-mail messages sent to the user are sent to this external address.

GrantSendOnBehalfTo

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxOrMailUserOrMailContactIdParameter[]

The GrantSendOnBehalfTo parameter specifies the DN of recipients that can send messages on behalf of this user.

HiddenFromAddressListsEnabled

Optional

System.Boolean

The HiddenFromAddressListsEnabled parameter specifies whether the user appears in the address list. The default value is $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.

MacAttachmentFormat

Optional

Microsoft.Exchange.Data.Directory.Recipient.MacAttachmentFormat

The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format for messages sent to the mail user. The valid values for this parameter are:

  • BinHex
  • UuEncode
  • AppleSingle
  • AppleDouble

By default, this parameter is set to BinHex.

The acceptable values for the MacAttachmentFormat parameter are dependent on the MessageFormat parameter. If the MessageFormat parameter is set to Text, you can only use BinHex or UuEncode values for this parameter. If the MessageFormat parameter is set to Mime, you can only use BinHex, AppleSingle, or AppleDouble values for this parameter.

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 MailTipTranslations parameter message must be less than or equal to 250 characters. Multiple languages can be separated by commas.

MaxReceiveSize

Optional

Microsoft.Exchange.Data.Unlimited

The MaxReceiveSize parameter specifies the maximum size of e-mail messages that can be received by the mail user, from 1 kilobyte (KB) through 2,097,151 KB.

If not specified, there are no size restrictions.

MaxSendSize

Optional

Microsoft.Exchange.Data.Unlimited

The MaxSendSize parameter specifies the maximum size of e-mail messages that can be sent by the mail user, from 1 KB through 2,097,151 KB.

If not specified, there are no size restrictions.

MessageBodyFormat

Optional

Microsoft.Exchange.Data.Directory.Recipient.MessageBodyFormat

The MessageBodyFormat parameter specifies the message body format for messages sent to the mail user. The valid values for this parameter are:

  • Text
  • Html
  • TextAndHtml

By default, this parameter is set to TextAndHtml.

The MessageFormat and MessageBodyFormat parameters are interdependent. If the MessageFormat parameter is set to Mime, the MessageBodyFormat parameter can be set to any valid value. However, if the MessageFormat parameter is set to Text, the MessageBodyFormat parameter can only be set to Text. Therefore, if you want to set this parameter to Html or TextAndHtml, you must also set the MessageFormat parameter to Mime.

MessageFormat

Optional

Microsoft.Exchange.Data.Directory.Recipient.MessageFormat

The MessageFormat parameter specifies the message format for messages sent to the mail user.

The valid values for this parameter are:

  • Text
  • Mime

By default, this parameter is set to Mime.

The MessageFormat and MessageBodyFormat parameters are interdependent. If the MessageFormat parameter is set to Mime, the MessageBodyFormat parameter can be set to any valid value. However, if the MessageFormat parameter is set to Text, the MessageBodyFormat parameter can only be set to Text. Therefore, if you want to change the MessageFormat parameter from Mime to Text, you must also change the MessageBodyFormat parameter to Text.

ModeratedBy

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ModeratedBy parameter specifies the users responsible for moderating the messages sent to the distribution group. To designate more than one user, separate the users with commas.

This parameter is required if you set the ModerationEnabled parameter to $true. If you leave this parameter blank and there is a user already specified as the manager of this distribution group, the ModeratedBy parameter is automatically set by the ManagedBy parameter of the distribution group. Otherwise, an error is returned.

ModerationEnabled

Optional

System.Boolean

The ModerationEnabled parameter specifies whether to enable moderation for the distribution group. 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 of the user.

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

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The PrimarySmtpAddress parameter specifies the primary SMTP address.

RecipientLimits

Optional

Microsoft.Exchange.Data.Unlimited

The RecipientLimits parameter specifies the maximum number of recipients for messages from this user.

RejectMessagesFrom

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The RejectMessagesFrom parameter specifies the recipients from which to reject messages. You can use any of the following values to specify the recipients:

  • Alias
  • Canonical name
  • Display name
  • DN
  • GUID
  • Name
  • LegacyExchangeDN
  • Primary SMTP e-mail address

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

RejectMessagesFromDLMembers

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The RejectMessagesFromDLMembers parameter specifies the distribution list members from which to reject messages. You can use any of the following values to specify the recipients:

  • DN
  • Alias
  • Canonical name
  • Display name
  • GUID
  • Name
  • LegacyExchangeDN
  • Primary SMTP e-mail address

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

RejectMessagesFromSendersOrMembers

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]

The RejectMessagesFromSendersOrMembers parameter specifies the recipients who aren't allowed to send e-mail messages to this mail user. You can use any of the following values to specify the recipients:

  • Alias
  • Canonical name
  • Display name
  • DN
  • GUID
  • Name
  • LegacyExchangeDN
  • Primary SMTP e-mail address

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

RemovePicture

Optional

System.Management.Automation.SwitchParameter

The RemovePicture parameter specifies whether to remove the picture that a user has added to a mailbox.

RemoveSpokenName

Optional

System.Management.Automation.SwitchParameter

The RemoveSpokenName parameter specifies whether to remove the spoken name that a user has added to a mailbox.

RequireSenderAuthenticationEnabled

Optional

System.Boolean

The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated recipients. The default value is $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 mail users to change their Windows Live ID password the next time they sign in to Outlook Live. Valid input for this parameter is $true or $false.

SamAccountName

Optional

System.String

The SamAccountName parameter specifies the logon name used to support clients and servers running older versions of the operating system, such as Microsoft Windows NT 4.0, Windows 98, Windows 95, and LAN Manager. This attribute must contain fewer than 20 characters. An account name can contain letters, numbers, and the following punctuation marks and symbols:

  • !
  • #
  • $
  • %
  • ^
  • &
  • -
  • .
  • _
  • {
  • }
  • |
  • ~

SecondaryAddress

Optional

System.String

The SecondaryAddress parameter specifies the secondary address used by the Unified Messaging (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 they send a message to the moderated distribution group. You can use one of the following values:

  • Always
  • Internal
  • Never

If you want notifications to be sent to all senders, set this parameter to Always.

If you want notifications to be sent only to the senders who are internal to your organization, set this parameter to Internal.

To disable all status notifications, set this parameter to Never.

Aa995971.note(en-us,EXCHG.140).gifNote:
The sender is always notified if the message is rejected by the moderators, regardless of the value of this parameter.

The default value is Never.

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.

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.

UseMapiRichTextFormat

Optional

Microsoft.Exchange.Data.Directory.Recipient.UseMapiRichTextFormat

The UseMapiRichTextFormat parameter specifies how messages in MAPI rich text format (RTF) are handled for this mail user. You can use one of the following values:

  • Never
  • Always
  • UseDefaultSettings

To convert all messages sent to this user to plain text, set this parameter to Never. To always send messages to this user in MAPI RTF, set this parameter to Always. To have the format determined based on the setting configured in the MAPI client that sent the message, set this parameter to UseDefaultSettings.

UsePreferMessageFormat

Optional

System.Boolean

The UsePreferMessageFormat parameter specifies whether the message format settings configured for the mail user override the global settings configured for the remote domain. To have the message format settings configured for the mail user to override any global settings, set this parameter to $true.

UserPrincipalName

Optional

System.String

The UserPrincipalName parameter specifies a UPN for the user.

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

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.

Error Description

 

 

Exceptions Description

 

 

This example sets the e-mail address outside the organization to which mail-enabled user John Peoples' (john) e-mail is sent.

Set-MailUser john -ExternalEmailAddress john@tailspintoys.com
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft