Set Mail User operation

The Set Mail User process modifies the mail-related attributes of an existing user in the Active Directory directory service. The following table describes the input parameters for Set Mail User process

 Adapter request parameters for Set Mail User process

Element

Definition

Required

<Identity>

Takes one of the following values:

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

    The Identity parameter cannot be used if the Instance parameter is specified.

Yes

<AcceptMessagesOnlyFrom>

Specifies the mailbox users, mail users, and mail contacts that can send e-mail messages to this mail user

You can also specify Microsoft Exchange as a valid recipient for this parameter. If you configure a mail user to accept messages only from the Microsoft 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 mail user to accept messages from all senders.)

No

<AcceptMessagesOnlyFromDLMembers>

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:

  • 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 mail user to accept messages from all senders.)

No

<Alias>

Specifies the alias of the user

An alias can contain letters, numbers, and the following punctuation marks and symbols: !, #, $, %, ^, &, *, -, ., /, =, ?, _, {, }, |, ~

No

<Confirm>

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

No

<CreateDTMFMap>

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

No

<CustomAttribute1>

Specifies custom attributes

You can use these attributes to store additional information

No

<CustomAttribute10>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute11>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute12>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute13>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute14>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute15>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute2>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute3>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute4>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute5>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute6>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute7>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute8>

Specifies custom attributes

You can use these attributes to store additional information.

No

<CustomAttribute9>

Specifies custom attributes

You can use these attributes to store additional information.

No

<DisplayName>

Specifies the display name of the user

No

<DomainController>

Specifies the Fully Qualified Domain Name (FQDN) of the domain controller that writes this configuration change to Active Directory

The DomainController parameter should be included in the command.

No

<EmailAddresses>

Specifies the e-mail alias of the mail user

All valid Microsoft Exchange 2007 e-mail address types may be used. You can specify multiple values for the EmailAddresses parameter as a comma-delimited list.

No

<EmailAddressPolicyEnabled>

Specifies whether the e-mail addresses for the mailbox will be automatically updated based on the e-mail address policies defined

When this parameter is set to true, you cannot change the PrimarySmtpAddress or WindowsEmailAddress parameters.

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

<ExternalEmailAddress>

Specifies an e-mail address outside of the organization

E-mail messages sent to the user are sent to this external address.

No

<GrantSendOnBehalfTo>

Specifies the distinguished name (DN) of recipients that can send messages on behalf of this user

No

<HiddenFromAddressListsEnabled>

Specifies whether the user appears in the address list

The default value is $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

<MacAttachmentFormat>

Specifies the Apple Macintosh Operating System attachment format for messages that are sent to the mail user

The valid values for this parameter are:

  • BinHex
  • UUENCODE
  • AppleSingle
  • AppleDoubleBy 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.

No

<MaxReceiveSize>

Specifies the maximum size of e-mail messages that can be received by the mail user, from 1 kilobyte (KB) to 2,097,151 KB If not specified, there will be no size restrictions.

No

<MaxSendSize>

Specifies the maximum size of e-mail messages that can be sent by the mail user, from 1 KB to 2,097,151 KB

If not specified, there will be no size restrictions.

No

<MessageBodyFormat>

Specifies the message body format for messages that are 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

No

<MessageFormat>

Specifies the message format for messages that are 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.

No

<Name>

Specifies the name of the user.

No

<PrimarySmtpAddress>

Specifies the primary SMTP address.

No

<RecipientLimits>

Specifies the maximum number of recipients for messages from this user.

No

<RejectMessagesFrom>

Specifies the recipients from which to reject messages.

No

<RejectMessagesFromDLMembers>

Specifies the distribution list members from which to reject messages.

No

<RequireSenderAuthenticationEnabled>

Specifies whether to accept messages only from authenticated recipients. The default value is $false.

No

<SamAccountName>

Defines 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: !, #, $, %, ^, &, *, -, ., /, =, ?, _, {, }, |, ~

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>

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

No

<UMDtmfMap>

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

No

<UseMapiRichTextFormat>

Specifies how messages in MAPI Rich Text Format (RTF) will be handled for this mail user

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

No

<UsePreferMessageFormat>

Specifies whether the message format settings configured for the mail user will override the global settings configured for the remote domain

Set this parameter to $true to have the message format settings configured for the mail user to override any global settings

No

<UserPrincipalName>

Specifies a user principal name (UPN) for the user

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*