Remove-AddressRewriteEntry

 

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

Use the Remove-AddressRewriteEntry cmdlet to remove an existing address rewrite entry that is no longer needed.

Syntax

remove-addressrewriteentry -Identity <AddressRewriteEntryIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-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 Remove-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.

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

Identity

Required

Microsoft.Exchange.Management.MessagingPolicies.AddressRewrite.AddressRewriteEntryIdParameter

This parameter specifies the address rewrite entry to be removed. The Identity parameter will accept a GUID, or the unique address rewrite name. You can omit the Identity parameter label.

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 computers that have the Edge Transport server role installed. The Edge Transport server role writes only to the local ADAM instance.

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 how to remove existing address rewrite entries that are no longer needed. The first example shows how to remove a specific address rewrite entry.

The second example shows how to view a list of all address rewrite entries that will be removed if they contain the string "contoso.com". To remove multiple address rewrite entries, you must pipe the results of the Get-AddressRewriteEntry command to the Remove-AddressRewriteEntry command. You use the WhatIf parameter to simulate the actions that the command would take without actually applying the changes. If you remove the WhatIf parameter and run the command again, the address rewrite entries will be removed.

For more information about pipelining, see Pipelining.

Remove-AddressRewriteEntry "Address rewrite entry for contoso.com"
Get-AddressRewriteEntry "*contoso.com" | Remove-AddressRewriteEntry -WhatIf:$true