Set-RemoteDomain

 

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

Use the Set-RemoteDomain cmdlet to configure a managed connection for a remote domain. When you set a remote domain, you can control mail flow with more precision, specify message formatting and policy, and specify acceptable character sets for messages that are sent to and received from the remote domain.

Before you configure a remote domain by using the Set-RemoteDomain cmdlet, you must create a remote domain by using the New-RemoteDomain cmdlet in the Exchange Management Shell or by using the Exchange Management Console. For more information, see the following topics:

• New-RemoteDomain

• How to Configure Message Format Settings for a Remote Domain

Syntax

Set-RemoteDomain -Identity <RemoteDomainIdParameter> [-AllowedOOFType <External | InternalLegacy | ExternalLegacy | None>] [-AutoForwardEnabled <$true | $false>] [-AutoReplyEnabled <$true | $false>] [-CharacterSet <String>] [-Confirm [<SwitchParameter>]] [-ContentType <MimeHtmlText | MimeText | MimeHtml>] [-DeliveryReportEnabled <$true | $false>] [-DisplaySenderName <$true | $false>] [-DomainController <Fqdn>] [-LineWrapSize <Unlimited>] [-MeetingForwardNotificationEnabled <$true | $false>] [-Name <String>] [-NDREnabled <$true | $false>] [-NonMimeCharacterSet <String>] [-TNEFEnabled <Nullable>] [-UseSimpleDisplayName <$true | $false>] [-WhatIf [<SwitchParameter>]]

Set-RemoteDomain [-AllowedOOFType <External | InternalLegacy | ExternalLegacy | None>] [-AutoForwardEnabled <$true | $false>] [-AutoReplyEnabled <$true | $false>] [-CharacterSet <String>] [-Confirm [<SwitchParameter>]] [-ContentType <MimeHtmlText | MimeText | MimeHtml>] [-DeliveryReportEnabled <$true | $false>] [-DisplaySenderName <$true | $false>] [-DomainController <Fqdn>] [-Instance <DomainContentConfig>] [-LineWrapSize <Unlimited>] [-MeetingForwardNotificationEnabled <$true | $false>] [-Name <String>] [-NDREnabled <$true | $false>] [-NonMimeCharacterSet <String>] [-TNEFEnabled <Nullable>] [-UseSimpleDisplayName <$true | $false>] [-WhatIf [<SwitchParameter>]]

Detailed Description

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

• Exchange Server Administrator role and local Administrators group for the target server

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

Parameters

Parameter	Required	Type	Description
Identity	Required	Microsoft.Exchange.Configuration.Tasks.RemoteDomainIdParameter	Use this parameter to specify the display name of the remote domain. The length of the name cannot exceed 64 characters.
AllowedOOFType	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.AllowedOOFType	Use this parameter to specify the type of Out of Office (OOF) notification that is returned to users at the remote domain. Valid values are External, ExternalLegacy, None, and InternalLegacy. The default value is External. This parameter can be used on a Hub Transport server. However, this parameter cannot be used on an Edge Transport server.
AutoForwardEnabled	Optional	System.Boolean	Use this parameter to allow or suppress messages that are auto-forwarded by client e-mail programs in your organization. Setting this parameter to $true enables auto-forwarded messages to be delivered to the remote domain. The default value is $false. This parameter can be used on a Hub Transport server. However, this parameter cannot be used on an Edge Transport server.
AutoReplyEnabled	Optional	System.Boolean	Use this parameter to allow or suppress messages that are automatic replies from client e-mail programs in your organization. Setting this parameter to $true enables automatic replies to be delivered to the remote domain. The default value is $false. This parameter can be used on a Hub Transport server. However, this parameter cannot be used on an Edge Transport server.
CharacterSet	Optional	System.String	Use this parameter to specify a character set for this remote domain. The character set that you specify will only be used for MIME messages that do not have their own character set specified. Setting this parameter will not overwrite character sets are already specified in the outbound mail. For a list of valid character set names, see Supported Character Sets for Remote Domain Configuration. To remove the character set value (set it to "null"), set the value as follows: -CharacterSet $null
Confirm	Optional	System.Management.Automation.SwitchParameter	The Confirm parameter 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.
ContentType	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.ContentType	Use this parameter to define the outbound message content type and formatting. Valid values for this parameter are MimeHtmlText, MimeText, MimeHtml. MimeHtmlText converts messages to MIME messages that use HTML formatting, unless the original message is a text message. If the original message is a text message, outbound message will be a MIME message that uses text formatting. MimeText converts all messages to MIME messages that use text formatting. MimeHtml converts all messages to MIME messages that use HTML formatting. The default value is MimeHtmlText.
DeliveryReportEnabled	Optional	System.Boolean	Use this parameter to allow or suppress delivery reports from Hub Transport servers in your organization to the remote domain. The default value is $true. This parameter can be used on a Hub Transport server. However, this parameter cannot be used on an Edge Transport server.
DisplaySenderName	Optional	System.Boolean	Valid values for this parameter are $true or $false. The default value is $true. This parameter is used for older versions of Exchange and should only be set under direction of Microsoft support services.
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration information from the Active Directory directory service, include the DomainController parameter on the command. The DomainController parameter is not supported on computers that have the Edge Transport server role installed. The Edge Transport server role writes and reads only to the local Active Directory Application Mode (ADAM) instance.
Instance	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.DomainContentConfig	Use this parameter to pass a whole object to the command to be processed. This parameter is mainly used in scripts where a whole object must be passed to the command.
LineWrapSize	Optional	Microsoft.Exchange.Data.Unlimited	Use this parameter to specify the line-wrap size for outbound messages. The parameter takes an integer between 0 and 132, or you can overload the parameter by setting the value to unlimited. The default value is unlimited.
MeetingForwardNotificationEnabled	Optional	System.Boolean	Use this parameter to enable or disable meeting forward notifications. When this parameter is enabled, meeting requests that are forwarded to recipients in the remote domain generate a meeting forward notification to the meeting organizer. When this parameter is disabled, meeting requests that are forwarded to recipients in the remote domain will not generate a meeting forward notification to the meeting organizer. Valid values for this parameter are $true or $false. The default value is $true. This parameter can be used on a Hub Transport server. However, this parameter cannot be used on an Edge Transport server.
Name	Optional	System.String	Use this parameter to create a unique name for a remote domain object.
NDREnabled	Optional	System.Boolean	Use this parameter to allow or suppress non-delivery reports (NDRs) from your organization. Setting this parameter to $false suppresses NDRs to the remote domain. The default value is $true. This parameter can be used on a Hub Transport server. However, this parameter cannot be used on an Edge Transport server.
NonMimeCharacterSet	Optional	System.String	Use this parameter to specify a character set for this remote domain. The character set that you specify will only be used for non-MIME (RFC 822, text) messages that do not have their own character set specified. Setting this parameter will not overwrite character sets are already specified in the outbound mail. For a list of valid character set names see Supported Character Sets for Remote Domain Configuration. To remove the character set value (set it to "null"), set the value as follows: -NonMimeCharacterSet $null
TNEFEnabled	Optional	System.Nullable	Use this parameter to control whether Transport Neutral Encapsulation Format (TNEF) message encoding is used on messages that are sent to the remote domain. Valid values for this parameter are $true, $false, and $null. $True: TNEF encoding is used on all messages that are sent to the remote domain. $False: TNEF encoding is not used on any messages that are sent to the remote domain. $Null: TNEF encoding is not specified for the remote domain. TNEF encoding for recipients in the remote domain may be specified by the following: The value of the UseMapiRichTextFormat parameter for any mail user or mail contact objects The sender's per-recipient settings in Microsoft Office Outlook The sender's default Internet message settings in Outlook The default value is $null.
UseSimpleDisplayName	Optional	System.Boolean	After you install Update Rollup 4 for Exchange Server 2007 Service Pack 1 (SP1) on the Exchange server, you can use this parameter to configure the system so that the simple display name appears in outgoing messages. Setting this parameter to $true enables automatic replies to be delivered to the remote domain. The default value is $false. This parameter can be used on a Hub Transport server. However, this parameter cannot be used on an Edge Transport server.
WhatIf	Optional	System.Management.Automation.SwitchParameter	The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value when you use the WhatIf parameter.

Example

The following code example performs the following actions:

• It disables out-of-office notifications to the remote domain.

• It suppresses delivery reports that are sent from clients in your organization to the remote domain.

• It enables TNEF message data on messages that are sent to the remote domain.

Set-RemoteDomain -Identity Contoso -AllowedOOFType None -DeliveryReportEnabled $false -TNEFEnabled $true