New-AddressRewriteEntry
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the New-AddressRewriteEntry cmdlet to create a new address rewrite entry that rewrites sender and recipient e-mail addresses in e-mail messages that are sent to and from an e-mail organization.
Syntax
new-AddressRewriteEntry -Name <String> -ExternalAddress <String> -InternalAddress <String> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ExceptionList <MultiValuedProperty>] [-OutboundOnly <$true | $false>] [-TemplateInstance <PSObject>] [-WhatIf [<SwitchParameter>]]
Detailed Description
In Microsoft Exchange Server 2007, address rewriting lets you modify the addresses of senders and recipients on messages that enter and leave an Exchange 2007 organization. You configure Address Rewriting agents on the Receive connector and Send connector on a computer that has the Edge Transport server role installed.
To run the New-AddressRewriteEntry cmdlet on a computer that has the Edge Transport server role installed, you must log on by using an account that is a member of the local Administrators group on that computer.
Note
You can use only one e-mail address. You cannot map multiple e-mail addresses to one e-mail address.
For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
ExternalAddress |
Required |
System.String |
This parameter specifies the external e-mail address or domain name that is used when you rewrite an internal e-mail address or domain name. If an e-mail address is specified in InternalAddress, the value that is specified in ExternalAddress must also be an e-mail address. If a domain name or domain name with a wildcard character is specified in InternalAddress, a domain name must be specified in ExternalAddress. Addresses or domain names can be entered in the following two formats:
Note The asterisk character cannot be used with the ExternalAddress parameter. |
InternalAddress |
Required |
System.String |
This parameter specifies the internal e-mail address or domain name to be rewritten. Addresses or domain names can be entered in the following three formats:
|
Name |
Required |
System.String |
This parameter enables the administrator to modify the unique name for this address rewrite entry. |
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. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the command. The DomainController parameter is not supported on Edge Transport servers. The Edge Transport server role writes only to the local ADAM instance. |
ExceptionList |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
This parameter specifies the domain names that should not be rewritten when the InternalAddress parameter contains a value that specifies multiple domain names. You can separate multiple domain names that are included with the ExceptionList parameter with commas. For more information about how to add values to or remove values from multivalued properties, see Modifying Multivalued Properties. |
OutboundOnly |
Optional |
System.Boolean |
This parameter specifies whether e-mail addresses should be rewritten only when e-mail messages leave the Exchange 2007 organization, or if addresses should be rewritten when messages are sent in both directions. The two possible values for this parameter are Note This parameter cannot be set to |
TemplateInstance |
Optional |
System.Management.Automation.PSObject |
When an existing object is supplied to this parameter, the command uses the configuration of that object to create an identical copy of the object on a local or target server. For more information, see Templates. |
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 with the WhatIf parameter. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
Exceptions
| Exceptions | Description |
|---|---|
|
Example
The following examples show three different scenarios:
Rewrite a single e-mail address. E-mail messages in both directions are rewritten.
Rewrite all e-mail addresses for the contoso.com domain. E-mail messages in both directions are rewritten.
Rewrite all e-mail addresses for the contoso.com domain, and all subdomains, except research.contoso.com and corp.contoso.com. Only outbound e-mail messages are rewritten.
New-AddressRewriteEntry -Name "Address rewrite entry for david@contoso.com" -InternalAddress david@contoso.com -ExternalAddress david@northwindtraders.com
New-AddressRewriteEntry -Name "Address rewrite entry for all contoso.com e-mail addresses" -InternalAddress contoso.com -ExternalAddress northwindtraders.com
New-AddressRewriteEntry -Name "Address rewrite entry for all contoso.com and subdomain e-mail addresses" -InternalAddress *.contoso.com -ExternalAddress northwindtraders.com -OutboundOnly:$true -ExceptionList research.contoso.com,corp.contoso.com