Remove-ContentFilterPhrase

 

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

Use the Remove-ContentFilterPhrase cmdlet to remove one or all custom words that the Content Filter agent processes.

Syntax

Remove-ContentFilterPhrase -Identity <ContentFilterPhraseIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

Remove-ContentFilterPhrase [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Phrase <ContentFilterPhraseIdParameter>] [-WhatIf [<SwitchParameter>]]

Detailed Description

To run the Remove-ContentFilterPhrase cmdlet, the account you use must be delegated the following:

  • Exchange View-Only Administrator role

To run the Remove-ContentFilterPhrase 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 Microsoft Exchange Server 2007, see Permission Considerations.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.ContentFilterPhraseIdParameter

The value of the Identity parameter is the same as the value of the Phrase parameter that is used in the content filter phrase configuration. You must enclose the Identity parameter in double quotation marks if the phrase contains a space, as follows, for example, "This is a bad phrase".

You cannot use the Phrase parameter if the Identity parameter is used.

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 run the Edge Transport server role. The Edge Transport server role reads and writes only to the local ADAM instance.

Phrase

Optional

Microsoft.Exchange.Configuration.Tasks.ContentFilterPhraseIdParameter

The Phrase parameter is the same Phrase parameter that is used in the content filter phrase configuration. You must enclose the Phrase parameter in double quotation marks if the phrase contains a space, as follows, for example, "This is a bad phrase".

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

 

Example

The following code example shows the syntax for the Remove-ContentFilterPhrase command. In this example, the custom word is the BadWord identity, This is a bad phrase.

Remove-ContentFilterPhrase -Identity "This is a bad phrase"