Applies to: Exchange Server 2007
Topic Last Modified: 2007-08-27
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>] [-DomainController <Fqdn>] [-Enabled <$true |
$false>] [-ExternalMailEnabled <$true | $false>]
[-Instance <RecipientFilterConfig>] [-InternalMailEnabled
<$true | $false>] [-RecipientValidationEnabled <$true |
$false>]
|
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
|
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
|
ExternalMailEnabled |
Optional |
System.Boolean |
Valid input for the ExternalMailEnabled parameter is
|
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
|
RecipientValidationEnabled |
Optional |
System.Boolean |
Valid input for the RecipientValidationEnabled Enabled
parameter is |
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 Exchange Server 2007, see Permission Considerations.
Input Types
Return Types
Errors
Error | Description |
---|---|
|
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 IP Block list and how to add recipients to the blocked recipient list.
The BlockedRecipients property takes multiple values; when you pass a value to the BlockedRecipients property, the existing value is replaced with the new value. For procedural information that explains how to append values to and existing multi-value property, see Modifying Multivalued Properties.
Copy Code | |
---|---|
Set-RecipientFilterConfig -RecipientValidationEnabled:$true Set-RecipientFilterConfig -BlockListEnabled:$true -BlockedRecipients user1@contoso.com,user2@contoso.com |