[This topic is in progress.]

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2011-05-07

Use the Set-RecipientFilterConfig cmdlet to enable and configure the Recipient Filter agent on a computer that has the Edge Transport server role or the Hub Transport server role installed.

Syntax


`Set-RecipientFilterConfig [-BlockedRecipients <MultiValuedProperty>] [-BlockListEnabled <$true \| $false>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Enabled <$true \| $false>] [-ExternalMailEnabled <$true \| $false>] [-InternalMailEnabled <$true \| $false>] [-RecipientValidationEnabled <$true \| $false>] [-WhatIf [<SwitchParameter>]]`

Detailed Description

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Anti-spam features" entry in the Transport Permissions topic.

Parameters

Parameter	Required	Type	Description
BlockedRecipients	Optional	Microsoft.Exchange.Data.MultiValuedProperty	The BlockedRecipients parameter specifies one or more SMTP addresses. To enter multiple SMTP addresses, separate the addresses by using a comma. The maximum number of individual SMTP addresses that you can input is 800.
BlockListEnabled	Optional	System.Boolean	The BlockListEnabled parameter specifies whether the Recipient Filter agent blocks messages sent to recipients listed in the BlockedRecipients parameter. Valid input for the BlockListEnabled parameter is `$true` or `$false`. The default setting is `$false`. When the BlockListEnabled parameter is set to `$true`, the Recipient Filter agent blocks messages sent to recipients listed in the BlockedRecipients parameter.
Confirm	Optional	System.Management.Automation.SwitchParameter	The Confirm switch 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 switch.
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. The DomainController parameter isn't supported on the Edge Transport server role. The Edge Transport server role writes only to the Active Directory Lightweight Directory Services (AD LDS) instance.
Enabled	Optional	System.Boolean	The Enabled parameter specifies whether the Recipient Filter agent is enabled on the computer on which you're running the command. Valid input for the Enabled parameter is `$true` or `$false`. The default setting is `$true`. When the Enabled parameter is set to `$true`, the Recipient Filter agent is enabled on the computer on which you're running the command.
ExternalMailEnabled	Optional	System.Boolean	The ExternalMailEnabled parameter specifies whether all messages received from unauthenticated connections by servers external to your organization are passed through the Recipient Filter agent for processing. Valid input for the ExternalMailEnabled parameter is `$true` or `$false`. The default setting is `$true`. When the ExternalMailEnabled parameter is set to `$true`, all messages received from unauthenticated connections by servers external to your organization are passed through the Recipient Filter agent for processing.
InternalMailEnabled	Optional	System.Boolean	The InternalMailEnabled parameter specifies whether all messages from authenticated sender domains that belong to authoritative domains in the enterprise are passed through the Recipient Filter agent for processing. Valid input for the InternalMailEnabled parameter is `$true` or `$false`. The default setting is `$false`. When the InternalMailEnabled parameter is set to `$true`, all messages from authenticated sender domains that belong to authoritative domains in the enterprise are passed through the Recipient Filter agent for processing.
RecipientValidationEnabled	Optional	System.Boolean	The RecipientValidationEnabled parameter specifies whether the Recipient Filter agent blocks messages addressed to recipients that don't exist in the organization. Valid input for the RecipientValidationEnabled parameter is `$true` or `$false`. The default setting is `$false`. When the RecipientValidationEnabled parameter is set to `$true`, the Recipient Filter agent blocks messages addressed to recipients that don't exist in the organization.
WhatIf	Optional	System.Management.Automation.SwitchParameter	The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, 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 switch.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

Examples

EXAMPLE 1

This example modifies the Recipient Filter agent configuration so that recipient validation is enabled.

	Copy Code
Set-RecipientFilterConfig -RecipientValidationEnabled $true

EXAMPLE 2

This example makes the following changes to the Recipient Filter agent configuration:

Enables the Blocked Recipients list.
Adds two users to the Blocked Recipients list.

	Copy Code
Set-RecipientFilterConfig -BlockListEnabled $true -BlockedRecipients user1@contoso.com,user2@contoso.com