Applies to: Exchange Server 2007 SP2, Exchange Server 2007 SP1
Topic Last Modified: 2009-05-18
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>] [-Instance <RecipientFilterConfig>] [-InternalMailEnabled <$true | $false>] [-RecipientValidationEnabled <$true | $false>] [-WhatIf [<SwitchParameter>]]
Parameters
|
Parameter
|
Required
|
Type
|
Description
|
|---|
|
BlockedRecipients
|
Optional
|
Microsoft.Exchange.Data.MultiValuedProperty
|
Valid input for the BlockedRecipients Enabled parameter is one or more SMTP addresses. You can enter up to 800 individual SMTP addresses for the BlockedRecipients this parameter.
|
|
BlockListEnabled
|
Optional
|
System.Boolean
|
Valid input for the BlockListEnabled Enabled parameter is $true or $false. The default setting is $false. When the BlockListEnabled parameter is set to $true, the Recipient Filter agent blocks messages that are sent to recipients that are listed in the BlockedRecipients parameter.
|
|
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.
|
|
Enabled
|
Optional
|
System.Boolean
|
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 are running the Set-RecipientFilterConfig cmdlet.
|
|
ExternalMailEnabled
|
Optional
|
System.Boolean
|
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 from unauthenticated connections are passed through the Recipient Filter agent for processing.
|
|
Instance
|
Optional
|
Microsoft.Exchange.Data.Directory.SystemConfiguration.RecipientFilterConfig
|
The Instance parameter enables you to pass an entire object to the command to be processed. It is mainly used in scripts where an entire object must be passed to the command.
|
|
InternalMailEnabled
|
Optional
|
System.Boolean
|
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 your enterprise are passed through the Recipient Filter agent for processing.
|
|
RecipientValidationEnabled
|
Optional
|
System.Boolean
|
Valid input for the RecipientValidationEnabled Enabled parameter is $true or $false. The default setting is $false. When the RecipientValidationEnabled parameter is set to $true, the Recipient Filter agent blocks messages that contain recipients that do not exist in your organization.
|
|
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.
|
Detailed Description
To run the Set-RecipientFilterConfig cmdlet, the account you use must be delegated the following:
-
Exchange Server Administrator role and local Administrators group for the target server
To run the Set-RecipientFilterConfig 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.
Input Types
Return Types
Errors
Example
The following code examples shows two Set-RecipientFilterConfig commands.
The first code example shows how to modify the recipient filter configuration so that recipient validation is enabled.
The second code example shows how to enable the Blocked Recipient list and how to add recipients to the Blocked Recipient list.
The BlockedRecipients parameter takes multiple values. When you pass a value to the BlockedRecipients parameter, the existing value is replaced with the new value. For more information about how to add or remove values from multivalued properties, see Modifying Multivalued Properties.
Set-RecipientFilterConfig -RecipientValidationEnabled:$true
Set-RecipientFilterConfig -BlockListEnabled:$true -BlockedRecipients user1@contoso.com,user2@contoso.com