Applies to: Exchange Server 2007
Topic Last Modified: 2007-06-05

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

Syntax


Set-MailContact -Identity <MailContactIdParameter> [-AcceptMessagesOnlyFrom <RecipientIdParameter[]>] [-AcceptMessagesOnlyFromDLMembers <RecipientIdParameter[]>] [-Alias <String>] [-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>] [-Extensions <MultiValuedProperty>] [-ExternalEmailAddress <ProxyAddress>] [-GrantSendOnBehalfTo <MailboxOrMailUserIdParameter[]>] [-HiddenFromAddressListsEnabled <$true \| $false>] [-MacAttachmentFormat <BinHex \| UuEncode \| AppleSingle \| AppleDouble>] [-MaxReceiveSize <Unlimited>] [-MaxRecipientPerMessage <Unlimited>] [-MaxSendSize <Unlimited>] [-MessageBodyFormat <Text \| Html \| TextAndHtml>] [-MessageFormat <Text \| Mime>] [-Name <String>] [-PrimarySmtpAddress <SmtpAddress>] [-RejectMessagesFrom <RecipientIdParameter[]>] [-RejectMessagesFromDLMembers <RecipientIdParameter[]>] [-RequireSenderAuthenticationEnabled <$true \| $false>] [-SecondaryAddress <String>] [-SecondaryDialPlan <UMDialPlanIdParameter>] [-SimpleDisplayName <String>] [-UMDtmfMap <MultiValuedProperty>] [-UseMapiRichTextFormat <Never \| Always \| UseDefaultSettings>] [-UsePreferMessageFormat <$true \| $false>] [-WindowsEmailAddress <SmtpAddress>]

Set-MailContact -Identity <MailContactIdParameter>
[-AcceptMessagesOnlyFrom <RecipientIdParameter[]>]
[-AcceptMessagesOnlyFromDLMembers <RecipientIdParameter[]>]
[-Alias <String>] [-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>] [-Extensions <MultiValuedProperty>]
[-ExternalEmailAddress <ProxyAddress>] [-GrantSendOnBehalfTo
<MailboxOrMailUserIdParameter[]>]
[-HiddenFromAddressListsEnabled <$true | $false>]
[-MacAttachmentFormat <BinHex | UuEncode | AppleSingle |
AppleDouble>] [-MaxReceiveSize <Unlimited>]
[-MaxRecipientPerMessage <Unlimited>] [-MaxSendSize
<Unlimited>] [-MessageBodyFormat <Text | Html |
TextAndHtml>] [-MessageFormat <Text | Mime>] [-Name
<String>] [-PrimarySmtpAddress <SmtpAddress>]
[-RejectMessagesFrom <RecipientIdParameter[]>]
[-RejectMessagesFromDLMembers <RecipientIdParameter[]>]
[-RequireSenderAuthenticationEnabled <$true | $false>]
[-SecondaryAddress <String>] [-SecondaryDialPlan
<UMDialPlanIdParameter>] [-SimpleDisplayName <String>]
[-UMDtmfMap <MultiValuedProperty>] [-UseMapiRichTextFormat
<Never | Always | UseDefaultSettings>]
[-UsePreferMessageFormat <$true | $false>]
[-WindowsEmailAddress <SmtpAddress>]


Set-MailContact [-AcceptMessagesOnlyFrom <RecipientIdParameter[]>] [-AcceptMessagesOnlyFromDLMembers <RecipientIdParameter[]>] [-Alias <String>] [-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>] [-Extensions <MultiValuedProperty>] [-ExternalEmailAddress <ProxyAddress>] [-GrantSendOnBehalfTo <MailboxOrMailUserIdParameter[]>] [-HiddenFromAddressListsEnabled <$true \| $false>] [-Instance <MailContact>] [-MacAttachmentFormat <BinHex \| UuEncode \| AppleSingle \| AppleDouble>] [-MaxReceiveSize <Unlimited>] [-MaxRecipientPerMessage <Unlimited>] [-MaxSendSize <Unlimited>] [-MessageBodyFormat <Text \| Html \| TextAndHtml>] [-MessageFormat <Text \| Mime>] [-Name <String>] [-PrimarySmtpAddress <SmtpAddress>] [-RejectMessagesFrom <RecipientIdParameter[]>] [-RejectMessagesFromDLMembers <RecipientIdParameter[]>] [-RequireSenderAuthenticationEnabled <$true \| $false>] [-SecondaryAddress <String>] [-SecondaryDialPlan <UMDialPlanIdParameter>] [-SimpleDisplayName <String>] [-UMDtmfMap <MultiValuedProperty>] [-UseMapiRichTextFormat <Never \| Always \| UseDefaultSettings>] [-UsePreferMessageFormat <$true \| $false>] [-WindowsEmailAddress <SmtpAddress>]

Set-MailContact [-AcceptMessagesOnlyFrom
<RecipientIdParameter[]>] [-AcceptMessagesOnlyFromDLMembers
<RecipientIdParameter[]>] [-Alias <String>]
[-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>] [-Extensions <MultiValuedProperty>]
[-ExternalEmailAddress <ProxyAddress>] [-GrantSendOnBehalfTo
<MailboxOrMailUserIdParameter[]>]
[-HiddenFromAddressListsEnabled <$true | $false>] [-Instance
<MailContact>] [-MacAttachmentFormat <BinHex | UuEncode |
AppleSingle | AppleDouble>] [-MaxReceiveSize <Unlimited>]
[-MaxRecipientPerMessage <Unlimited>] [-MaxSendSize
<Unlimited>] [-MessageBodyFormat <Text | Html |
TextAndHtml>] [-MessageFormat <Text | Mime>] [-Name
<String>] [-PrimarySmtpAddress <SmtpAddress>]
[-RejectMessagesFrom <RecipientIdParameter[]>]
[-RejectMessagesFromDLMembers <RecipientIdParameter[]>]
[-RequireSenderAuthenticationEnabled <$true | $false>]
[-SecondaryAddress <String>] [-SecondaryDialPlan
<UMDialPlanIdParameter>] [-SimpleDisplayName <String>]
[-UMDtmfMap <MultiValuedProperty>] [-UseMapiRichTextFormat
<Never | Always | UseDefaultSettings>]
[-UsePreferMessageFormat <$true | $false>]
[-WindowsEmailAddress <SmtpAddress>]

Parameters

Parameter	Required	Type	Description
Identity	Required	Microsoft.Exchange.Configuration.Tasks.MailContactIdParameter	The Identity parameter takes one of the following values: ADObjectID GUID Distinguished name (DN) Domain\SamAccountName User principal name (UPN) Legacy DN E-mail address Contact alias
AcceptMessagesOnlyFrom	Optional	Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]	The AcceptMessagesOnlyFrom parameter specifies the recipients who can send e-mail messages to this mail contact. It can take any of the following values for the valid senders: Distinguished name (DN) Canonical name GUID Name Display name Alias Legacy Exchange DN Primary Simple Mail Transfer Protocol (SMTP) e-mail address By default, this parameter is blank. This default value enables the mail contact to accept messages from all recipients.
AcceptMessagesOnlyFromDLMembers	Optional	Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]	The AcceptMessagesOnlyFromDLMembers parameter specifies the distribution groups that 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 By default, this parameter is blank.
Alias	Optional	System.String	The Alias parameter specifies the alias of the mailenabled contact. An alias can contain letters, numbers, and the following punctuation marks and symbols: ! # $ % ^ & * + - . / = ? _ { } \| ~
CreateDTMFMap	Optional	System.Boolean	This parameter specifies that a dual tone multi-frequency (DTMF) map be created for the contact.
CustomAttribute1	Optional	System.String	The CustomAttribute1 parameter specifies custom attributes. You can use these attributes to store additional information.
CustomAttribute10	Optional	System.String	The CustomAttribute10 parameter specifies custom attributes. You can use these attributes to store additional information.
CustomAttribute11	Optional	System.String	The CustomAttribute11 parameter specifies custom attributes. You can use these attributes to store additional information.
CustomAttribute12	Optional	System.String	The CustomAttribute12 parameter specifies custom attributes. You can use these attributes to store additional information.
CustomAttribute13	Optional	System.String	The CustomAttribute13 parameter specifies custom attributes. You can use these attributes to store additional information.
CustomAttribute14	Optional	System.String	The CustomAttribute14 parameter specifies custom attributes. You can use these attributes to store additional information.
CustomAttribute15	Optional	System.String	The CustomAttribute15 parameter specifies custom attributes. You can use these attributes to store additional information.
CustomAttribute2	Optional	System.String	The CustomAttribute2 parameter specifies custom attributes. You can use these attributes to store additional information.
CustomAttribute3	Optional	System.String	The CustomAttribute3 parameter specifies custom attributes. You can use these attributes to store additional information.
CustomAttribute4	Optional	System.String	The CustomAttribute4 parameter specifies custom attributes. You can use these attributes to store additional information.
CustomAttribute5	Optional	System.String	The CustomAttribute5 parameter specifies custom attributes. You can use these attributes to store additional information.
CustomAttribute6	Optional	System.String	The CustomAttribute6 parameter specifies custom attributes. You can use these attributes to store additional information.
CustomAttribute7	Optional	System.String	The CustomAttribute7 parameter specifies custom attributes. You can use these attributes to store additional information.
CustomAttribute8	Optional	System.String	The CustomAttribute8 parameter specifies custom attributes. You can use these attributes to store additional information.
CustomAttribute9	Optional	System.String	The CustomAttribute9 parameter specifies 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	To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory, include the DomainController parameter in the command.
EmailAddresses	Optional	Microsoft.Exchange.Data.ProxyAddressCollection	The EmailAddresses parameter specifies the distribution list proxy e-mail addresses.
EmailAddressPolicyEnabled	Optional	System.Boolean	The EmailAddressPolicyEnabled parameter specifies whether the e-mail addresses for the mailbox will be automatically updated based on the e-mail address policies defined.
Extensions	Optional	Microsoft.Exchange.Data.MultiValuedProperty	This parameter specifies one or more extension numbers for the contact. When the parameter is set, all extension numbers within the dial plan must be unique.
ExternalEmailAddress	Optional	Microsoft.Exchange.Data.ProxyAddress	The ExternalEmailAddress parameter specifies the external e-mail address of the recipient.
GrantSendOnBehalfTo	Optional	Microsoft.Exchange.Configuration.Tasks.MailboxOrMailUserIdParameter[]	The GrantSendOnBehalfTo parameter specifies the distinguished names (DN) 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. If the value is $true, the contact does not appear in the address list. The default value is $false.
Instance	Optional	Microsoft.Exchange.Data.Directory.Management.MailContact	The Instance parameter 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.
MacAttachmentFormat	Optional	Microsoft.Exchange.Data.Directory.Recipient.MacAttachmentFormat	The MacAttachmentFormat parameter specifies the Apple Macintosh Operating System attachment format for messages that are 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.
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 is not 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 is not 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 that are 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 that are 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.
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.Configuration.Tasks.RecipientIdParameter[]	The RejectMessagesFrom parameter specifies the recipients from which to reject messages.
RejectMessagesFromDLMembers	Optional	Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[]	The RejectMessagesFromDLMembers parameter specifies the distribution list members from which to reject messages.
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	This parameter specifies the secondary address that is used by the UM-enabled contact.
SecondaryDialPlan	Optional	Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter	This parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address.
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	This parameter specifies if 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) 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.
UsePreferMessageFormat	Optional	System.Boolean	The UsePreferMessageFormat parameter specifies whether the message format settings configured for the mail contact 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 contact to override any global settings.
WindowsEmailAddress	Optional	Microsoft.Exchange.Data.SmtpAddress	The WindowsEmailAddress parameter specifies the Windows e-mail address for this mailbox. This address is not used by Exchange.

Detailed Description

The Set-MailContact cmdlet modifies an existing mail-enabled contact in Active Directory by specifying the contact's identity and the attributes to be modified.

To run the Set-MailContact cmdlet, the account you use must be delegated the following:

Exchange Recipient Administrator role

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

Input Types

Return Types

Errors

Error	Description

Exceptions

Exceptions	Description

Example

In this example, the Set-MailContact command is used to set John Peoples' external e-mail address to john@contoso.com.

	Copy Code
Set-MailContact -Identity "John Peoples" -ExternalEmailAddress "john@contoso.com"