Export (0) Print
Expand All
Related Help Topics
Loading
No resources found.
Related Blog Articles
Loading
No resources found.
Expand Minimize

Set-MailContact

 

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-11-16

Use the Set-MailContact cmdlet to modify an existing mail-enabled contact in Active Directory.

Set-MailContact -Identity <MailContactIdParameter> [-AcceptMessagesOnlyFrom <MultiValuedProperty>] [-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>] [-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] [-Alias <String>] [-ArbitrationMailbox <MailboxIdParameter>] [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] [-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>] [-ExtensionCustomAttribute1 <MultiValuedProperty>] [-ExtensionCustomAttribute2 <MultiValuedProperty>] [-ExtensionCustomAttribute3 <MultiValuedProperty>] [-ExtensionCustomAttribute4 <MultiValuedProperty>] [-ExtensionCustomAttribute5 <MultiValuedProperty>] [-ExternalEmailAddress <ProxyAddress>] [-ForceUpgrade <SwitchParameter>] [-GrantSendOnBehalfTo <MultiValuedProperty>] [-HiddenFromAddressListsEnabled <$true | $false>] [-IgnoreDefaultScope <SwitchParameter>] [-MacAttachmentFormat <BinHex | UuEncode | AppleSingle | AppleDouble>] [-MailTip <String>] [-MailTipTranslations <MultiValuedProperty>] [-MaxReceiveSize <Unlimited>] [-MaxRecipientPerMessage <Unlimited>] [-MaxSendSize <Unlimited>] [-MessageBodyFormat <Text | Html | TextAndHtml>] [-MessageFormat <Text | Mime>] [-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled <$true | $false>] [-Name <String>] [-PrimarySmtpAddress <SmtpAddress>] [-RejectMessagesFrom <MultiValuedProperty>] [-RejectMessagesFromDLMembers <MultiValuedProperty>] [-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] [-RemovePicture <SwitchParameter>] [-RemoveSpokenName <SwitchParameter>] [-RequireSenderAuthenticationEnabled <$true | $false>] [-SecondaryAddress <String>] [-SecondaryDialPlan <UMDialPlanIdParameter>] [-SendModerationNotifications <Never | Internal | Always>] [-SimpleDisplayName <String>] [-UMDtmfMap <MultiValuedProperty>] [-UseMapiRichTextFormat <Never | Always | UseDefaultSettings>] [-UsePreferMessageFormat <$true | $false>] [-WhatIf [<SwitchParameter>]] [-WindowsEmailAddress <SmtpAddress>]

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 "Recipients Provisioning Permissions" section in the Mailbox Permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailContactIdParameter

The Identity parameter specifies the mail contact.

This parameter accepts the following values:

  • Alias
    Example: JPhillips
  • Canonical DN
    Example: Atlanta.Corp.Contoso.Com/Users/JPhillips
  • Display Name
    Example: Jeff Phillips
  • Distinguished Name (DN)
    Example: CN=JPhillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com
  • Domain\Account
    Example: Atlanta\JPhillips
  • GUID
    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2
  • Immutable ID
    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2@contoso.com
  • Legacy Exchange DN
    Example: /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhillips
  • SMTP Address
    Example: Jeff.Phillips@contoso.com
  • User Principal Name
    Example: JPhillips@contoso.com

AcceptMessagesOnlyFrom

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AcceptMessagesOnlyFrom parameter specifies the mailbox users, mail users, and mail contacts that 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 only from the Microsoft Exchange recipient, it 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, this parameter is blank. This default value enables the mail contact to accept messages from all senders.

AcceptMessagesOnlyFromDLMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AcceptMessagesOnlyFromDLMembers parameter 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:

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

AcceptMessagesOnlyFromSendersOrMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

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

Alias

Optional

System.String

The Alias parameter specifies the alias of the mail­enabled contact. 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 used to manage the moderation process.

BypassModerationFromSendersOrMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

  • DN
  • Canonical name
  • GUID
  • Name
  • Display name
  • Legacy Exchange DN
  • Primary SMTP e-mail

By default, this value is blank. This default value ensures that all messages are moderated when this mail contact is configured for moderation.

Senders that are designated as moderators for this mail contact are allowed to send messages to this mail contact.

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

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 contact. All valid Microsoft Exchange e-mail address types may be used. You can specify multiple values for the EmailAddresses parameter as a comma-delimited list.

importantImportant:
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 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 addresses for the mailbox are automatically updated based on the e-mail address policies defined.

ExtensionCustomAttribute1

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Understanding Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute2

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Understanding Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute3

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Understanding Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute4

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Understanding Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute5

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Understanding Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExternalEmailAddress

Optional

Microsoft.Exchange.Data.ProxyAddress

The ExternalEmailAddress parameter specifies the external e-mail address of the recipient.

ForceUpgrade

Optional

System.Management.Automation.SwitchParameter

The ForceUpgrade parameter suppresses the following confirmation: "To save changes on object <object name>, the object must be upgraded to the current Exchange version. After the upgrade, this object can't be managed by an earlier version of the Exchange management tools. Do you want to continue to upgrade and save the object?" This confirmation appears when you upgrade a mail contact that was created in Exchange Server 2003. You can't manage an Exchange 2003 mail contact by using the Exchange Management Console until you update the object's version.

GrantSendOnBehalfTo

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The GrantSendOnBehalfTo parameter specifies the DNs of recipients that can send messages on behalf of this contact.

HiddenFromAddressListsEnabled

Optional

System.Boolean

The HiddenFromAddressListsEnabled parameter specifies whether the contact appears in address lists. The possible values for this parameter are $true or $false. If the value is $true, the contact doesn't appear 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.

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 contact. 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 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 value in that language. Each MailTip parameter value 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, from 1 kilobyte (KB) to 2,097,151 KB.

If a value isn't specified, the limit is set to the maximum value.

MaxRecipientPerMessage

Optional

Microsoft.Exchange.Data.Unlimited

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

MaxSendSize

Optional

Microsoft.Exchange.Data.Unlimited

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

If a value isn't specified, the limit is set to the maximum value.

MessageBodyFormat

Optional

Microsoft.Exchange.Data.Directory.Recipient.MessageBodyFormat

The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact. 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 contact.

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 who are responsible for moderating the messages sent to the mail-enabled contact. 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 who is already specified as the manager of this distribution group, the ModeratedBy parameter is automatically set by the ManagedBy parameter of the mail-enabled contact. Otherwise, an error is returned.

ModerationEnabled

Optional

System.Boolean

The ModerationEnabled parameter specifies whether to enable moderation for the mail-enabled contact. The possible values for this parameter are $true or $false. 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 mail-enabled contact.

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The PrimarySmtpAddress parameter specifies the primary SMTP e-mail address.

RejectMessagesFrom

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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. This default value enables the mail contact to accept messages from all senders.

RejectMessagesFromDLMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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:

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

By default, this parameter is blank. This default value enables the mail contact to accept messages from all senders.

RejectMessagesFromSendersOrMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RejectMessagesFromSendersOrMembers parameter specifies the recipients who aren't allowed to send e-mail messages to this mail contact. 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. This default value enables the mail contact 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 mail contact. A picture file can be added to the mail contact by using the Import-RecipientDataProperty cmdlet.

RemoveSpokenName

Optional

System.Management.Automation.SwitchParameter

The RemoveSpokenName parameter specifies whether to remove the spoken name that a user has added to a mail contact. A sound file can be added to the mail contact by using the Import-RecipientDataProperty cmdlet.

RequireSenderAuthenticationEnabled

Optional

System.Boolean

The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated recipients. The default value is $false.

SecondaryAddress

Optional

System.String

The SecondaryAddress parameter specifies the secondary address that's used by the Unified Messaging (UM)-enabled contact.

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 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 only to the senders internal to your organization.

Set this parameter to Never to disable all status notifications.

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

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

UsePreferMessageFormat

Optional

System.Boolean

The UsePreferMessageFormat parameter specifies whether the message format settings configured for the mail contact override the global settings configured for the remote domain. The possible values for this parameter are $true or $false. Set this parameter to $true to have the message format settings configured for the mail contact to override any global settings. The default value is $false.

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.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

This example sets John Rodman's external e-mail address to john@contoso.com.

Set-MailContact -Identity "John Rodman" -ExternalEmailAddress "john@contoso.com"
 © 2010 Microsoft Corporation. All rights reserved.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft