Set-ReceiveConnector

Identity

Required

Microsoft.Exchange.Configuration.Tasks.ReceiveConnectorIdParameter

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

AdvertiseClientSettings

Optional

System.Boolean

The AdvertiseClientSettings parameter specifies whether the SMTP server name, port number, and authentication settings are displayed in the Outlook Web App About page, accessed from the Help menu.

The default value is $true.

AuthMechanism

Optional

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

The AuthMechanism 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 ExternalAuthoritative, the PermissionGroups parameter must also have the value ExchangeServers.

Banner

Optional

System.String

The Banner parameter specifies an override to the default 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

The BinaryMimeEnabled parameter specifies whether the BINARYMIME EHLO keyword is advertised in the EHLO response to the remote server and is available for use. 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 isn't 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

The Bindings parameter specifies the local IP address and TCP port numbers 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 configured on all network adapters to listen for inbound messages.

Note:

You must specify a local IP address that's 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 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 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 serviced by the Receive connector.
  

ChunkingEnabled

Optional

System.Boolean

The ChunkingEnabled parameter specifies whether the CHUNKING EHLO keyword is advertised in the EHLO response to the remote server and is available for use. 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 isn't 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

The Comment parameter specifies an optional comment. You must enclose the Comment parameter in quotation marks ("), for example: "this is an admin note".

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.

ConnectionInactivityTimeout

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The ConnectionInactivityTimeout parameter specifies the maximum amount of idle time before a connection to a Receive connector is closed. The default value for a Receive connector configured on a Hub Transport server is 5 minutes. The default value for a Receive connector configured on an Edge Transport server is 1 minute.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

For example, to specify a connection inactivity time-out of 5 minutes, enter 00:05:00.

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 from 00:00:01 through 1.00:00:00.

ConnectionTimeout

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The ConnectionTimeout 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 configured on a Hub Transport server is 10 minutes The default value for a Receive connector configured on an Edge Transport server is 5 minutes.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

For example, to specify a connection time-out of 5 minutes, enter 00:05:00.

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 from 00:00:01 through 1.00:00:00.

DefaultDomain

Optional

Microsoft.Exchange.Configuration.Tasks.AcceptedDomainIdParameter

The DefaultDomain parameter specifies the domain name to append to values 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

The DeliveryStatusNotificationEnabled parameter specifies whether the delivery status notification (DSN) EHLO keyword is advertised in the EHLO response to the remote server and is available for use. 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 isn't advertised in the EHLO response to the remote server and is disabled. The DSN extension to extended SMTP (ESMTP) provides enhanced DSN functionality specified in RFC 1891.

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.

DomainSecureEnabled

Optional

System.Boolean

The DomainSecureEnabled parameter specifies the first part of the process to enable mutual Transport Layer Security (TLS) authentication for the domains 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 attribute of your transport configuration contains at least one domain serviced by this Receive connector. The wildcard character (*) isn't supported in domains configured for mutual TLS authentication. The same domain must also be defined on the corresponding Send connector, and in the value of the TLSSendDomainSecureList attribute of your Transport configuration.
  

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

• All Receive connectors defined on a Hub Transport server.
  
• User-created Receive connectors defined on an Edge Transport server.
  

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

EightBitMimeEnabled

Optional

System.Boolean

The EightBitMimeEnabled parameter specifies whether the 8BITMIME EHLO keyword is advertised in the EHLO response to the remote server and is available for use. 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 isn't advertised in the EHLO response to the remote server and is disabled.

EnableAuthGSSAPI

Optional

System.Boolean

The EnableAuthGSSAPI parameter specifies how to control the advertisement of the Generic Security Services application programming interface (GSSAPI) authentication method when Integrated Windows authentication is enabled on this connector. If the AuthMechanism parameter contains Integrated, and the EnableAuthGSSAPI parameter is set to $true, the AUTH GSSAPI NTLM keyword is advertised in the EHLO response of the Receive connector. Clients may use Kerberos or NTLM to authenticate with the Receive connector. If the AuthMechanism parameter contains Integrated, and the EnableAuthGSSAPI parameter is set to $false, the AUTH NTLM keyword is advertised in the EHLO response of the Receive connector. Clients may only use NTLM to authenticate with the Receive connector.

If you have Internet Information Services (IIS) messaging servers that authenticate with this Receive connector, you should set the value of the EnableAuthGSSAPI parameter to $false. Authentication with computers running Microsoft Exchange Server 2003 isn't affected by the value of the EnableAuthGSSAPI parameter. Exchange 2003 servers use the authentication methods advertised in the X-EXPS keyword. The X-EXPS keyword is advertised in the EHLO response of the Receive connector when the AuthMechanism parameter contains ExchangeServer.

Valid values for this parameter are $true or $false. The default value is $false. By default, the EnableAuthGSSAPI parameter is set to $true only on the default Receive connector Client <Server Name> that's created only on Hub Transport servers.

Enabled

Optional

System.Boolean

The Enabled parameter specifies whether to enable the connector. 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

The EnhancedStatusCodesEnabled parameter specifies whether the ENHANCEDSTATUSCODES EHLO keyword is advertised in the EHLO response to the remote server and is available for use. 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 isn't advertised in the EHLO response to the remote server and is disabled. The ENHANCEDSTATUSCODES extension provides enhanced error and status information in DSNs sent to remote servers.

Fqdn

Optional

Microsoft.Exchange.Data.Fqdn

The Fqdn parameter specifies the FQDN 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 Default <Server Name> that's 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 fails.

LiveCredentialEnabled

Optional

System.Boolean

The LiveCredentialEnabled parameter is reserved for internal Microsoft use.

LongAddressesEnabled

Optional

System.Boolean

The LongAddressesEnabled parameter enables the Receive connector to accept long X.400 e-mail addresses. The X.400 e-mail addresses are encapsulated in SMTP e-mail addresses by using the Internet Mail Connector Encapsulated Address (IMCEA) encapsulation method.

When the value of this parameter is $false, the maximum length for a complete SMTP e-mail address is 571 characters.

When the value of this parameter is $true, the following changes are made:

• The XLONGADDR keyword is advertised in the EHLO response of the Receive connector.
  
• The accepted line length of an SMTP session is increased to 8,000 characters.
  
• Valid long addresses are accepted by the MAIL FROM and RCPT TO SMTP commands.
  

Therefore, X.400 e-mail addresses can be up to 1,860 characters long after IMCEA encapsulation.

Valid values for this parameter are $true or $false. The default value is $false. You can only modify this parameter on Receive connectors configured on Hub Transport servers.

MaxAcknowledgementDelay

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The MaxAcknowledgementDelay parameter specifies the period the transport server delays acknowledgement when receiving messages from a host that doesn't support shadow redundancy. When receiving messages from a host that doesn't support shadow redundancy, a Microsoft Exchange Server 2010 transport server delays issuing an acknowledgement until it verifies that the message has been successfully delivered to all recipients. However, if it takes too long to verify successful delivery, the transport server times out and issues an acknowledgement anyway. The default value is 30 seconds.

MaxHeaderSize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

The MaxHeaderSize 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 from 1 through 2147483647 bytes.

MaxHopCount

Optional

System.Int32

The MaxHopCount parameter specifies the maximum number of hops that a message can take before the message is rejected by the Receive connector. The maximum number of hops is determined by the number of Received headers in a submitted message. The default value is 30. The valid input range for this parameter is from 1 through 500.

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 from 1 through 2147483647. To disable the inbound connection limit on a Receive connector, enter a value of unlimited.

MaxInboundConnectionPercentagePerSource

Optional

System.Int32

The MaxInboundConnectionPercentagePerSource 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 from 1 through 100.

MaxInboundConnectionPerSource

Optional

Microsoft.Exchange.Data.Unlimited

The MaxInboundConnectionPerSource 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 from 1 through 10000. To disable the inbound connection per source limit on a Receive connector, enter a value of unlimited.

MaxLocalHopCount

Optional

System.Int32

The MaxLocalHopCount parameter specifies the maximum number of local hops that a message can take before the message is rejected by the Receive connector. The maximum number of local hops is determined by the number of Received headers that have local server addresses in a submitted message. The default value is 8. The valid input range for this parameter is from 0 through 50. When you specify a value of 0, the message is never rejected based on the number of local hops.

MaxLogonFailures

Optional

System.Int32

The MaxLogonFailures 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 from 0 through 10.

MaxMessageSize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

The MaxMessageSize parameter specifies the maximum size of a message. The default value is 10MB. When you enter a value, 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 from 65536 through 2147483647 bytes.

MaxProtocolErrors

Optional

Microsoft.Exchange.Data.Unlimited

The MaxProtocolErrors 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 from 0 through 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 from 1 through 512000.

MessageRateLimit

Optional

Microsoft.Exchange.Data.Unlimited

The MessageRateLimit 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 configured on a Hub Transport server is unlimited. The default value for a Receive connector configured on an Edge Transport server is 600 messages per minute. The valid input range for this parameter is from 1 through 2147483647. To remove the message rate limit on a Receive connector, enter a value of unlimited.

MessageRateSource

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MessageRateSourceFlags

The MessageRateSource parameter specifies how the message submission rate is calculated. It can have one of the following values:

• None   No message submission rate is calculated.
  
• IPAddress   The message submission rate is calculated for sending hosts.
  
• User   The message submission rate is calculated for sending users (specified with the MAIL FROM SMTP command).
  
• All   The message submission rate is calculated for both the sending users and sending hosts.
  

Name

Optional

System.String

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

OrarEnabled

Optional

System.Boolean

The OrarEnabled parameter specifies whether to enable the Originator Requested Alternate Recipient (ORAR). When the value of this parameter is $false, ORAR isn't supported. When the value of this parameter is $true, ORAR is supported by advertising the XORAR keyword in the EHLO response of the Receive connector. The actual ORAR information is transmitted in the RCPT TO SMTP command.

Valid values for this parameter are $true or $false. The default value is $false. If the e-mail address specified in the ORAR information is a long X.400 e-mail address, the LongAddressesEnabled parameter must be $true.

PermissionGroups

Optional

Microsoft.Exchange.Data.PermissionGroups

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

PipeliningEnabled

Optional

System.Boolean

The PipeliningEnabled parameter specifies whether the PIPELINING EHLO keyword is advertised in the EHLO response to the remote server and is available for use. 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 isn't 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

The ProtocolLoggingLevel parameter specifies whether to enable 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 configured on a Hub Transport server or an Edge Transport server is specified by using the Set-TransportServer cmdlet with the ReceiveProtocolLogPath parameter.

RemoteIPRanges

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RemoteIPRanges 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 range. 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

The RequireEHLODomain parameter specifies whether the remote computer must provide a domain name in the EHLO handshake after the SMTP connection is established. 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 doesn't provide the domain name, the SMTP connection is closed.

RequireTLS

Optional

System.Boolean

The RequireTLS parameter specifies whether all messages received by this connector require TLS transmission. Valid values for this parameter are $true or $false. The default value is $false. When the RequireTLS parameter is set to $true, all messages received by this connector require TLS transmission.

SizeEnabled

Optional

Microsoft.Exchange.Data.SizeMode

The SizeEnabled parameter specifies whether the SIZE SMTP extension is enabled. 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 isn't 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 isn't 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's allowed to accept to the sending server. If the advertised size of the inbound message exceeds the value in the MaxMessageSize parameter, the Receive connector responds to the remote server by using an error code and closes the connection.

SuppressXAnonymousTls

Optional

System.Boolean

The SuppressXAnonymousTls parameter specifies whether this Receive connector supports the standard TLS encryption for incoming connections. By default, all communications between Exchange 2010 Hub Transport servers is protected with TLS. However, if you need to disable TLS on a specific connection in your organization, you can create a specific Receive connector and set the SuppressXAnonymousTls parameter to $true. The default value is $false.

Before you can set this parameter to $true, you must use the Set-TransportServer command to set the UseDownGradedExchangeServerAuth parameter to $true on the server that this Receive connector is configured on.

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 from 00:00:00 through 00:10:00. When you set the value to 00:00:00, you disable the tarpitting interval.

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.