Set Mail Contact operation

The Set Mail Contact process modify an existing mail-enabled contact in the Active Directory directory service process.

Note

The Set Mail Contact operation supports Microsoft Exchange versions 2007, 2010, 2013 and 2016.

The following table describes the input parameters for Set Mail Contact:

Adapter request parameters for Set Mail Contact process

Element

Definition

Required

<Identity>

Has one of the following values:

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

Yes

<AcceptMessagesOnlyFrom>

Specifies the mailbox users, mail users, and mail contacts who can send e-mail messages to this mail contact

You can also specify Microsoft Exchange as a valid recipient for this parameter. If you configure a mail contact to accept messages from the Microsoft Exchange recipient, it will receive system-generated messages.

It 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 (This is the default parameter and it is blank. This default value enables the mail contact to accept messages from all senders.)

No

<AcceptMessagesOnlyFromDLMembers>

Specifies the distribution groups whose members are allowed to send e-mail messages to this mail contact

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 (This is default parameter and is blank. This default value enables the mail contact to accept messages from all senders)

No

<Alias>

The Alias parameter specifies the alias of the mail enabled contact. An alias can contain letters, numbers, and the following punctuation marks and symbols: !, #, $, %, ^, &, *, -, ., /, =, ?, _, {, }, |, ~

No

<CreateDTMFMap>

Specifies that a Dual Tone Multi-Frequency (DTMF) map be created for the contact

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

Important - Exchange 2007 does not validate custom addresses for proper formatting. You must ensure that the custom address you specify complies with the format requirements for that address type. As X.400 addresses are considered custom addresses in Exchange 2007, they are not validated. You must provide the correct syntax when specifying an X.400 address.

No

<EmailAddressPolicyEnabled>

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

No

{{<Extensions

Specifies one or more extension numbers for the contact

All extension numbers within the dial plan must be unique when set.

No

<ExternalEmailAddress>

Specifies the external e-mail address of the recipient

No

<GrantSendOnBehalfTo>

Specifies the Distinguished Names (DN) of recipients that can send messages on behalf of this contact

No

<HiddenFromAddressListsEnabled>

Specifies whether a contact appears in address lists

If the value is true, the contact does not appear 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.

The 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 sent to the mail contact

The valid values for this parameter are:

  • BinHex
  • UUENCODE
  • AppleSingle
  • AppleDoubleBy (This is a default parameter and is set to BinHex)

    The acceptable values 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, from 1 kilobyte (KB) to 2,097,151 KB

If a value is not specified, the limit is set to the maximum value.

No

<MaxRecipientPerMessage>

specifies the maximum number of recipients for messages from this mail contact.

No

<MaxSendSize>

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

If a value is not specified, the limit is set to the maximum value.

No

<MessageBodyFormat>

Specifies the message body format for messages that are sent to the mail contact

The valid values for this parameter are:

  • Text
  • Html
  • TextAndHtmlBy (This is default parameter and 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 contact.

The valid values for this parameter are:

  • Text
  • Mime (This is default parameter and 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 mail-enabled contact

No

<PrimarySmtpAddress>

Specifies the primary SMTP e-mail address

No

<RejectMessagesFrom>

Specifies the recipients whose messages are to be rejected

No

<RejectMessagesFromDLMembers>

Specifies the distribution list members whose messages are rejected

No

<RequireSenderAuthenticationEnabled>

Decides whether to accept messages only from authenticated recipients

The default value is false.

No

<SecondaryAddress>

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

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 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 contact

No

<UseMapiRichTextFormat>

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

  • Set this parameter to Never to convert all messages sent to this contact to plain text.
  • Set this parameter to Always to always send messages to this contact 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>

Decides whether the message format settings configured for the mail contact overrides the global settings configured for the remote domain

  • Set this parameter to true to have the message format settings configured for the mail contact to override any global settings.

No

<WindowsEmailAddress>

Specifies the Windows e-mail address for this mailbox

This address is not used by Exchange.

No

Was this page helpful? Yes No Submitting... Thank you

Comments