Set-SenderIdConfig

Article
09/29/2015

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

Use the Set-SenderIdConfig cmdlet to modify the Sender ID configuration on a computer that has the Edge Transport server role or the Hub Transport server role installed.

Syntax

Set-SenderIdConfig [-BypassedRecipients <MultiValuedProperty>] [-BypassedSenderDomains <MultiValuedProperty>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-ExternalMailEnabled <$true | $false>] [-Instance <SenderIdConfig>] [-InternalMailEnabled <$true | $false>] [-SpoofedDomainAction <StampStatus | Reject ] [-TempErrorAction <StampStatus | Reject | Delete>] [-WhatIf [<SwitchParameter>]]

Detailed Description

To run the Set-SenderIdConfig cmdlet, the account you use must be delegated the following:

Exchange Server Administrator role
Membership in the local Administrators group for the target server

To run the Set-SenderIdConfig 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
BypassedRecipients	Optional	Microsoft.Exchange.Data.MultiValuedProperty	The BypassedRecipients parameter takes one or more SMTP addresses. Messages that are bound for the SMTP addresses that are listed in this parameter are excluded from processing by the Sender ID agent. To enter multiple SMTP addresses, separate the addresses by using a comma and enclose the addresses in double quotation marks, as follows, for example: `"recipient1@contoso.com, recipient2@contoso.com"` The maximum number of recipients that you can input is 800.
BypassedSenderDomains	Optional	Microsoft.Exchange.Data.MultiValuedProperty	The BypassedSenderDomains parameter takes one or more domain names. Messages that originate from the domains that are listed in this parameter are excluded from processing by the Sender ID agent. To enter multiple domains, separate the domains by using a comma and enclose the addresses in double quotation marks, as follows, for example: `"contoso.com, example.com"` The maximum number of domain names that you can input is 800.
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 Sender ID agent is enabled on the computer on which you are running the Set-SenderIdConfig command.
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 Sender ID agent for processing.
Instance	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.SenderIdConfig	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 Sender ID agent for processing.
SpoofedDomainAction	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.SenderIdAction	This parameter specifies the action that the Sender ID agent takes on the message when the sender domain shows evidence of being spoofed. The SpoofedDomainAction parameter takes the following values: `StampStatus`, `Reject`. The default value is `StampStatus`.
TempErrorAction	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.SenderIdAction	This parameter specifies the action that the Sender ID agent takes on the message when a Sender ID status of TempError is returned. The TempErrorAction parameter takes the following values: `StampStatus`, `Reject`, `Delete`. The default value is `StampStatus`.
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 a Set-SenderIdConfig command that has the following modifications to the Sender ID configuration:

It sets the Sender ID agent to reject all messages that are sent from spoofed domains.
It specifies two recipients for the Sender ID agent to exclude when it processes messages.

Set-SenderIdConfig -SpoofedDomainAction Reject -BypassedRecipients user1@contoso.com,user2@contoso.com

Share via