Applies to: Exchange Server 2007 SP1, Exchange Server 2007
Topic Last Modified: 2007-07-23

Use the Set-ReceiveConnector cmdlet to modify an existing Receive connector on a computer that has the Hub Transport server role or the Edge Transport server role installed.

Syntax

Set-ReceiveConnector -Identity <ReceiveConnectorIdParameter> [-AuthMechanism <None | Tls | Integrated | BasicAuth | BasicAuthRequireTLS | ExchangeServer | ExternalAuthoritative>] [-Banner <String>] [-BinaryMimeEnabled <$true | $false>] [-Bindings <MultiValuedProperty>] [-ChunkingEnabled <$true | $false>] [-Comment <String>] [-ConnectionInactivityTimeout <EnhancedTimeSpan>] [-ConnectionTimeout <EnhancedTimeSpan>] [-DefaultDomain <AcceptedDomainIdParameter>] [-DeliveryStatusNotificationEnabled <$true | $false>] [-DomainController <Fqdn>] [-DomainSecureEnabled <$true | $false>] [-EightBitMimeEnabled <$true | $false>] [-Enabled <$true | $false>] [-EnhancedStatusCodesEnabled <$true | $false>] [-Fqdn <Fqdn>] [-MaxHeaderSize <ByteQuantifiedSize>] [-MaxHopCount <Int32>] [-MaxInboundConnection <Unlimited>] [-MaxInboundConnectionPercentagePerSource <Int32>] [-MaxInboundConnectionPerSource <Unlimited>] [-MaxLocalHopCount <Int32>] [-MaxLogonFailures <Int32>] [-MaxMessageSize <ByteQuantifiedSize>] [-MaxProtocolErrors <Unlimited>] [-MaxRecipientsPerMessage <Int32>] [-MessageRateLimit <Unlimited>] [-Name <String>] [-PermissionGroups <None | AnonymousUsers | ExchangeUsers | ExchangeServers | ExchangeLegacyServers | Partners | Custom>] [-PipeliningEnabled <$true | $false>] [-ProtocolLoggingLevel <None | Verbose>] [-RemoteIPRanges <MultiValuedProperty>] [-RequireEHLODomain <$true | $false>] [-RequireTLS <$true | $false>] [-SizeEnabled <Disabled | Enabled | EnabledWithoutValue>] [-TarpitInterval <EnhancedTimeSpan>]
Set-ReceiveConnector [-AuthMechanism <None | Tls | Integrated | BasicAuth | BasicAuthRequireTLS | ExchangeServer | ExternalAuthoritative>] [-Banner <String>] [-BinaryMimeEnabled <$true | $false>] [-Bindings <MultiValuedProperty>] [-ChunkingEnabled <$true | $false>] [-Comment <String>] [-ConnectionInactivityTimeout <EnhancedTimeSpan>] [-ConnectionTimeout <EnhancedTimeSpan>] [-DefaultDomain <AcceptedDomainIdParameter>] [-DeliveryStatusNotificationEnabled <$true | $false>] [-DomainController <Fqdn>] [-DomainSecureEnabled <$true | $false>] [-EightBitMimeEnabled <$true | $false>] [-Enabled <$true | $false>] [-EnhancedStatusCodesEnabled <$true | $false>] [-Fqdn <Fqdn>] [-Instance <ReceiveConnector>] [-MaxHeaderSize <ByteQuantifiedSize>] [-MaxHopCount <Int32>] [-MaxInboundConnection <Unlimited>] [-MaxInboundConnectionPercentagePerSource <Int32>] [-MaxInboundConnectionPerSource <Unlimited>] [-MaxLocalHopCount <Int32>] [-MaxLogonFailures <Int32>] [-MaxMessageSize <ByteQuantifiedSize>] [-MaxProtocolErrors <Unlimited>] [-MaxRecipientsPerMessage <Int32>] [-MessageRateLimit <Unlimited>] [-Name <String>] [-PermissionGroups <None | AnonymousUsers | ExchangeUsers | ExchangeServers | ExchangeLegacyServers | Partners | Custom>] [-PipeliningEnabled <$true | $false>] [-ProtocolLoggingLevel <None | Verbose>] [-RemoteIPRanges <MultiValuedProperty>] [-RequireEHLODomain <$true | $false>] [-RequireTLS <$true | $false>] [-SizeEnabled <Disabled | Enabled | EnabledWithoutValue>] [-TarpitInterval <EnhancedTimeSpan>]

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.ReceiveConnectorIdParameter

This parameter specifies the GUID or connector name that represents the Receive connector. The Identity label can be omitted.

AuthMechanism

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ReceiveConnector+AuthMechanisms

This parameter specifies the advertised and accepted authentication mechanisms. The authentication options are None, TLS, Integrated, BasicAuth, BasicAuthRequireTLS, ExchangeServer, and ExternalAuthoritative. You can enter multiple values for the AuthMechanism parameter by separating the values with commas. If the RequireTLS parameter is set to $true, the AuthMechanism parameter must be set to TLS (Transport Layer Security). If you set the AuthMechanism parameter to BasicAuthRequireTLS, you must also select BasicAuth and TLS. The AuthMechanism parameter value ExternalAuthoritative may only coexist with the value TLS. If you set the AuthMechanism parameter to ExternaAuthoritative, the PermissionGroups parameter must also have the value ExchangeServers.

Banner

Optional

System.String

This parameter overrides the default Simple Mail Transfer Protocol (SMTP) 220 banner. When the value of the Banner parameter is blank, the default SMTP banner is the following:

220 <Servername> Microsoft ESMTP MAIL service ready at <RegionalDay-Date-24HourTimeFormat> <RegionalTimeZoneOffset>

When you specify a value for the Banner parameter, you must use the following syntax:

"220 <RemainingBannerText>".

220 is the default "Service ready" SMTP response code as defined in RFC 2821.

BinaryMimeEnabled

Optional

System.Boolean

Valid values for this parameter are $True or $False. The default value is $True. When the BinaryMimeEnabled parameter is set to $True, the BINARYMIME EHLO keyword is advertised in the EHLO response to the remote server and is available for use. When the BinaryMimeEnabled parameter is set to $False, the BINARYMIME EHLO keyword is not advertised in the EHLO response to the remote server and is disabled. The BINARYMIME extension enables remote computers to send binary message data to this Receive connector. The BINARYMIME extension requires the data-chunking service extension, CHUNKING, to be enabled. Therefore, if you set the BinaryMimeEnabled parameter to $True, you should also set the ChunkingEnabled parameter to $True.

Bindings

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the local IP address and TCP port numbers that are used by the Receive connector to listen for inbound messages. Valid syntax for this parameter is <IP Address>:<TCP Port>, such as 192.168.1.1:25. The IP address 0.0.0.0 indicates that the Receive connector uses all IP addresses that are configured on all network adapters to listen for inbound messages.

Note:
You must specify a local IP address that is valid for the Hub Transport server or Edge Transport server on which the Receive connector is located. If you specify an invalid local IP address, the Microsoft Exchange Transport service may fail to start when the service is restarted. To specify all IP addresses that are configured on all network adapters, you can use the IP address 0.0.0.0.

The values that you specify by using the Bindings parameter must satisfy one of the following requirements for uniqueness:

  • You can specify a unique combination of IP address and TCP port that doesn't conflict with the IP address or TCP port that is used in the Bindings parameter of another Receive connector on the server.

  • You can use an existing combination of IP address and TCP port, but use the RemoteIPRanges parameter to restrict the remote servers that are serviced by the Receive connector.

ChunkingEnabled

Optional

System.Boolean

Valid values for this parameter are $True or $False. The default value is $True. When the ChunkingEnabled parameter is set to $True, the CHUNKING EHLO keyword is advertised in the EHLO response to the remote server and is available for use. When the ChunkingEnabled parameter is set to $False, the CHUNKING EHLO keyword is not advertised in the EHLO response to the remote server and is disabled. The CHUNKING extension enables large message bodies to be relayed by the remote server to the Receive connector in multiple, smaller chunks.

Comment

Optional

System.String

You must enclose the Comment parameter in double quotation marks, as follows, for example: "this is an admin note".

ConnectionInactivityTimeout

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter specifies the maximum amount of idle time before a connection to a Receive connector is closed. The default value for a Receive connector that is configured on a Hub Transport server is 5 minutes. The default value for a Receive connector that is configured on an Edge Transport server is 1 minute. To specify a value, enter the value as a time span: dd.hh:mm:ss, where d = days, h = hours, m = minutes, and s = seconds. The value specified by the ConnectionTimeout parameter must be greater than the value specified by the ConnectionInactivityTimeout parameter. The valid input range for either parameter is 00:00:01 to 1.00:00:00.

ConnectionTimeOut

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter specifies the maximum time that a connection can remain open, even if the connection is actively transmitting data. The default value for a Receive connector that is configured on a Hub Transport server is 10 minutes The default value for a Receive connector that is configured on an Edge Transport server is 5 minutes. To specify a value, enter the value as a time span: dd.hh:mm:ss, where d = days, h = hours, m = minutes, and s = seconds. The value specified by the ConnectionTimeout parameter must be greater than the value specified by the ConnectionInactivityTimeout parameter. The valid input range for either parameter is 00:00:01 to 1.00:00:00.

DefaultDomain

Optional

Microsoft.Exchange.Configuration.Tasks.AcceptedDomainIdParameter

This parameter specifies the domain name to append to values that are submitted to MAIL FROM: or RCPT TO: in the message envelope by a sending server if no domain name is provided.

DeliveryStatusNotificationEnabled

Optional

System.Boolean

Valid values for this parameter are $True or $False. The default value is $True. When the DeliveryStatusNotificationEnabled parameter is set to $True, the DSN EHLO keyword is advertised in the EHLO response to the remote server and is available for use. When the DeliveryStatusNotificationEnabled parameter is set to $False, the DSN EHLO keyword is not advertised in the EHLO response to the remote server and is disabled. The DSN extension to ESMTP provides enhanced delivery status notification (DSN) functionality that is specified in RFC 1891.

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.

DomainSecureEnabled

Optional

System.Boolean

This parameter is the first part of the process to enable mutual TLS authentication for the domains that are serviced by this Receive connector. Mutual TLS authentication functions correctly only if the following conditions are true:

  • The value of the DomainSecureEnabled parameter is $True.

  • The value of the AuthMechanism parameter contains TLS and doesn't contain ExternalAuthoritative.

  • The TLSReceiveDomainSecureList parameter in the Get-TransportConfig cmdlet contains at least one domain that is serviced by this Receive connector. The wildcard character (*) is not supported in domains that are configured for mutual TLS authentication. The same domain must also be defined on the corresponding Send connector, and in the value of the TLSSendDomainSecureList parameter in the Get-TransportConfig cmdlet.

The default value for DomainSecureEnabled is $False for the following types of Receive connectors:

  • All Receive connectors that are defined on a Hub Transport server.

  • User-created Receive connectors that are defined on an Edge Transport server.

The default value for DomainSecureEnabled is $True for default Receive connectors that are defined on an Edge Transport server.

EightBitMimeEnabled

Optional

System.Boolean

Valid values for this parameter are $True or $False. The default value is $True. When the EightBitMimeEnabled parameter is set to $True, the 8BITMIME EHLO keyword is advertised in the EHLO response to the remote server and is available for use. When the EightBitMimeEnabled parameter is set to $False, the 8BITMIME EHLO keyword is not advertised in the EHLO response to the remote server and is disabled.

Enabled

Optional

System.Boolean

Valid values for this parameter are $True or $False. The default value is $True. Use the Enabled parameter to enable or disable the connector.

EnhancedStatusCodesEnabled

Optional

System.Boolean

Valid values for this parameter are $True or $False. The default value is $True. When the EnhancedStatusCodesEnabled parameter is set to $True, the ENHANCEDSTATUSCODES EHLO keyword is advertised in the EHLO response to the remote server and is available for use. When the EnhancedStatusCodesEnabled parameter is set to $False, the ENHANCEDSTATUSCODES EHLO keyword is not advertised in the EHLO response to the remote server and is disabled. The ENHANCEDSTATUSCODES extension provides enhanced error and status information in DSNs that are sent to remote servers.

Fqdn

Optional

Microsoft.Exchange.Data.Fqdn

This parameter specifies the FQDN that is used as the destination server for connected messaging servers that use the Receive connector to send incoming messages. The value of this parameter is displayed to connected messaging servers whenever a destination server name is required, as in the following examples:

  • In the default SMTP banner of the Receive connector

  • In the EHLO/HELO response of the Receive connector

  • In the most recent Received: header field in the incoming message when the message enters the Hub Transport server or Edge Transport server

  • During TLS authentication

The default value of the Fqdn parameter is the FQDN of the Hub Transport server or Edge Transport server that contains the Receive connector.

Note:
Don’t modify the FQDN value on the default Receive connector named “Default <Server Name>” that is automatically created on Hub Transport servers. If you have multiple Hub Transport servers in your Exchange organization and you change the FQDN value on the “Default <Server Name>” Receive connector, internal mail flow between Hub Transport servers will fail.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ReceiveConnector

This 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.

MaxHeaderSize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

This parameter specifies in bytes the maximum size of the SMTP message header that the Receive connector accepts before it closes the connection. The default value is 65536 bytes. When you enter a value, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

Unqualified values are treated as bytes. The valid input range for this parameter is 1 to 2147483647 bytes.

MaxHopCount

Optional

System.Int32

This parameter specifies the maximum number of hops that a message can take before the message is rejected by the Receive connector. The default value is 30. The valid input range for this parameter is 1 to 500.

Note:
The maximum number of hops is determined by the number of "Received:" headers in a submitted message.

MaxInboundConnection

Optional

Microsoft.Exchange.Data.Unlimited

The MaxInboundConnection parameter specifies the maximum number of inbound connections that this Receive connector serves at the same time. The default value is 5000. The valid input range for this parameter is 1 to 2147483647. To disable the inbound connection limit on a Receive connector, enter a value of unlimited.

MaxInboundConnectionPercentagePerSource

Optional

System.Int32

This parameter specifies the maximum number of connections that a Receive connector serves at the same time from a single IP address. The value is expressed as the percentage of available remaining connections on a Receive connector. Enter the value as an integer without the percent (%) character. The default value is 2 percent. The valid input range for this parameter is 1 to 100.

MaxInboundConnectionPerSource

Optional

Microsoft.Exchange.Data.Unlimited

This parameter specifies the maximum number of inbound connections that this Receive connector serves at the same time from a single IP address. The default value is 100. The valid input range for this parameter is 1 to 10000. To disable the inbound connection per source limit on a Receive connector, enter a value of unlimited.

MaxLocalHopCount

Optional

System.Int32

This parameter specifies the maximum number of local hops that a message can take before the message is rejected by the Receive connector. The default value is 3. The valid input range for this parameter is 0 to 50. When you specify a value of 0, the message is never rejected based on the number of local hops.

Note:
The maximum number of local hops is determined by the number of "Received:" headers that have local server addresses in a submitted message.

MaxLogonFailures

Optional

System.Int32

This parameter specifies the number of logon failures that the Receive connector retries before closing the connection. The default value is 3. The valid input range for this parameter is 0 to 10. When you specify a value of 0, the connection is never closed because of logon failures.

MaxMessageSize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

This parameter specifies the maximum size of a message. The MaxMessageSize parameter takes an integer. The default value is 10MB. The maximum value is 2GB. When you enter an integer, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

Unqualified integers are treated as bytes. The valid input range for this parameter is 1 to 2147483647 bytes.

MaxProtocolErrors

Optional

Microsoft.Exchange.Data.Unlimited

This parameter specifies the maximum number of SMTP protocol errors that the Receive connector accepts before closing the connection. The default value is 5. The valid input range for this parameter is 0 to 2147483647. When you specify a value of unlimited, a connection is never closed because of protocol errors.

MaxRecipientsPerMessage

Optional

System.Int32

The MaxRecipientsPerMessage parameter specifies the maximum number of recipients per message that the Receive connector accepts before closing the connection. The default value is 200. The valid input range for this parameter is 1 to 512000.

MessageRateLimit

Optional

Microsoft.Exchange.Data.Unlimited

This parameter specifies the maximum number of messages that can be sent by a single client IP address per minute. The default value for a Receive connector that is configured on a Hub Transport server is unlimited. The default value for a receive connector that is configured on an Edge Transport server is 600 messages per minute. The valid input range for this parameter is 1 to 2147483647. To remove the message rate limit on a Receive connector, enter a value of unlimited.

Name

Optional

System.String

This parameter specifies the administrator-supplied name of the connector. Enter the Name parameter as a string as follows, for example: New Receive Connector.

PermissionGroups

Optional

Microsoft.Exchange.Data.PermissionGroups

This parameter defines the groups or roles that can submit messages to the Receive connector and the permissions that are assigned to those groups. A permission group is a predefined set of permissions that is granted to well-known security principals. The valid values for this parameter are as follows: None, AnonymousUsers, ExchangeUsers, ExchangeServers, ExchangeLegacyServers, and Partners. The default permission groups that are assigned to a Receive connector depend on the connector usage type that was specified by the Usage parameter when the Receive connector was created. For more information about Receive connector usage types, see Receive Connectors.

PipeliningEnabled

Optional

System.Boolean

Valid values for this parameter are $True or $False. The default value is $True. When the PipeliningEnabled parameter is set to $True, the PIPELINING EHLO keyword is advertised in the EHLO response to the remote server and is available for use. When the PipeliningEnabled parameter is set to $False, the PIPELINING EHLO keyword is not advertised in the EHLO response to the remote server and is disabled. The PIPELINING extension enables the remote server to send requests without awaiting a response from this Receive connector.

ProtocolLoggingLevel

Optional

Microsoft.Exchange.Data.ProtocolLoggingLevel

This parameter enables or disables protocol logging for the specified Receive connector. A value of Verbose enables protocol logging for the connector. A value of None disables protocol logging for the connector. The default value is None. The location of the Receive connector protocol logs for all Receive connectors that are configured on a Hub Transport server or an Edge Transport server is specified by using the ReceiveProtocolLogPath parameter of the Set-TransportServer cmdlet.

RemoteIPRanges

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the remote IP addresses from which this connector accepts messages. Valid syntax for this parameter is <Starting IP Address>-<Ending IP Address>, such as 192.168.1.1-192.168.1.10. You can specify multiple IP address ranges separated by commas.

Multiple Receive connectors on the same server can have overlapping remote IP address ranges as long as one IP address range is completely overlapped by another IP address. When remote IP address ranges overlap, the remote IP address range with the most specific match to the IP address of the connecting server is used.

RequireEHLODomain

Optional

System.Boolean

Valid values for this parameter are $True or $False. The default value is $False. When the RequireEHLODomain parameter is set to $True, the remote computer must provide a domain name in the EHLO handshake after the SMTP connection is established. If the remote computer does not provide the domain name, the SMTP connection is closed.

RequireTLS

Optional

System.Boolean

Valid values for this parameter are $True or $False. The default value is $False. When the RequireTLS parameter is set to $True, all messages that are received by this connector require TLS transmission.

SizeEnabled

Optional

Microsoft.Exchange.Data.SizeMode

Valid values for this parameter are Enabled, Disabled or EnabledwithoutValue. The default value is Enabled. When the SizeEnabled parameter is set to Enabled, the SIZE SMTP extension is enabled, and the maximum allowable message size value from the MaxMessageSize parameter is advertised in the EHLO banner. When the SizeEnabled parameter is set to Disabled, the SIZE SMTP extension is not used, and the maximum allowable message size value is never disclosed to the remote server. When the SizeEnabled parameter is set to EnabledWithoutValue, the SIZE SMTP extension is enabled, but the maximum allowable message size value from the MaxMessageSize parameter is not advertised in the EHLO banner. This allows the message to bypass message size checks for authenticated connections between Hub Transport servers. The SIZE SMTP extension is defined in RFC 1870. SIZE enables the source server to declare the size of the inbound message to the target server. It also allows the target server to declare the maximum message size that it is allowed to accept to the sending server. If the advertised size of the inbound message exceeds the value in the MessageSizeMax parameter, the Receive connector responds to the remote server by using an error code and closes the connection.

TarpitInterval

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The TarpitInterval parameter specifies the period of time to delay an SMTP response to a remote server that Exchange determines may be abusing the connection. Authenticated connections are never delayed in this manner. The default value is 5 seconds. To specify a value, enter the value as a time span: hh:mm:ss, where h = hours, m = minutes, and s = seconds. The valid input range for this parameter is 00:00:00 to 00:10:00. When you set the value to 00:00:00, you disable the tarpitting interval.

Detailed Description

The Set-ReceiveConnector cmdlet modifies an existing Receive connector. The Identity parameter is required when you run the Set-ReceiveConnector cmdlet.

After this task is completed, the Receive connector is modified.

To run the Set-ReceiveConnector 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-ReceiveConnector 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

Error Description

 

 

Example

The following example of the Set-ReceiveConnector command sets the Banner parameter to "220 Banner Text here" and the ConnectionTimeOut parameter to 00:15:00.

Copy Code
Set-ReceiveConnector -Identity "Internet Receive Connector" -Banner "220 Banner Text here" -ConnectionTimeout 00:15:00