New Receive Connector operation


The New Receive Connector process creates a new Receive connector on a computer that has the Hub Transport server role or the Edge Transport server role installed. The following table describes the input parameters for New Receive Connector process

 Adapter request parameters for New Receive Connector process

Element

Definition

Required

<Bindings>

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.

You must specify a value for the Bindings parameter when the following parameters are specified:

  • Internet or Usage parameter with a value of Internet
  • Partner or Usage parameter with a value of Partner
  • Custom or Usage parameter with a value of Custom

    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. However, when you use the New-ReceiveConnector cmdlet to create a Receive connector, you can only use the RemoteIPRanges parameter and the Bindings parameter together when the following parameters are specified:
  • Custom or Usage parameter with a value of Custom
  • Partner or Usage parameter with a value of Partner. You can't specify a value for the Bindings parameter with the New-ReceiveConnector cmdlet when the following parameters are specified:
  • Client or Usage parameter with a value of Client. The default value of the Bindings parameter is 0.0.0.0:587. This value indicates that the connector accepts connections on TCP port 587 on all IP addresses that are configured on all network adapters in the server.
  • Internal or Usage parameter with a value of Internal. The default value of the Bindings parameter is 0.0.0.0:25. This value indicates that the connector accepts connections on TCP port 25 on all IP addresses that are configured on all network adapters in the server.

Yes

<Client>

Specifies the Client usage type The usage type specifies the default permission groups and authentication methods that are assigned to the Receive connector. If you use the Client parameter, you can't use any of the following parameters:

  • Internal
  • Internet
  • Partner
  • Custom
  • Usage

    If you specify the Client parameter, you must specify a value for the RemoteIPRanges parameter. If you don't specify a value for a required parameter, the New-ReceiveConnector cmdlet will prompt you so that the command may continue.

Yes

<Internal>

Specifies the Internal usage type

The usage type specifies the default permission groups and authentication methods that are assigned to the Receive connector. If you use the Internal parameter, you can't use any of the following parameters:

  • Client
  • Internet
  • Partner
  • Custom
  • Usage

    If you specify the Internal parameter, you must specify a value for the RemoteIPRanges parameter. If you don't specify a value for a required parameter, the New-ReceiveConnector cmdlet will prompt you so that the command may continue.

Yes

<Internet>

Specifies the Internet usage type The usage type specifies the default permission groups and authentication methods that are assigned to the Receive connector. If you use the Internet parameter, you can't use any of the following parameters:

  • Client
  • Internal
  • Partner
  • Custom
  • Usage

    If you specify the Internet parameter, you must specify a value for the Bindings parameter. If you don't provide a value for a required parameter, the New-ReceiveConnector cmdlet will prompt you so that the command may continue.

Yes

<Name>

Specifies the administrator-supplied name of the connector

Enter the Name parameter as a string as follows, for example: "New Receive Connector".

Yes

<Partner>

Specifies the Partner usage type

The usage type specifies the default permission groups and authentication methods that are assigned to the Receive connector. If you use the Partner parameter, you can't use any of the following parameters:

  • Client
  • Internal
  • Internet
  • Custom
  • Usage

    If you specify the Partner parameter, you must specify a value for the following parameters:
  • Bindings
  • RemoteIPRanges

Yes

<RemoteIPRanges>

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. You must specify a value for the RemoteIPRanges parameter when the following parameters are specified:

  • Client or Usage parameter with a value of Client
  • Internal or Usage parameter with a value of Internal
  • Partner or Usage parameter with a value of Partner
  • Custom or Usage parameter with a value of CustomMultiple 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.

    You can't specify a value for the RemoteIPRanges parameter with the New-ReceiveConnector cmdlet when the Internet parameter or the Usage parameter with a value of Internet is specified. The default value of the RemoteIPRanges parameter for the Internet usage type is 0.0.0.0-255.255.255.255. This value indicates that the connector accepts connections from all remote IP addresses.

Yes

<Usage>

Specifies the default permission groups and authentication methods that are assigned to the Receive connector

The valid values for the Usage parameter are as follows: Client, Custom, Internal, Internet, and Partner. If you specify a value for the Usage parameter, you can't use any of the following parameters:

  • Client
  • Internal
  • Internet
  • Partner
  • Custom

    A value for the Bindings parameter is required if you specify any of the following values for the Usage parameter:

  • Internet
  • Partner
  • Custom

    A value for the RemoteIPRanges parameter is required if you specify any of the following values for the Usage parameter:

  • Client
  • Internal
  • Partner
  • Custom

    If you don't specify a value for a required parameter, the command will end unsuccessfully. The New-ReceiveConnector cmdlet will not prompt you for the missing required parameters.

Yes

<AuthMechanism>

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

No

<Banner>

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.

No

<BinaryMimeEnabled>

Enables or disables the BinaryMimeEnabled parameter

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.

No

<ChunkingEnabled>

Enables or disables the ChunkingEnabled parameter

Valid input for this parameter is 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.

No

<Comment>

Specifies a comment

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

No

<ConnectionInactivityTimeout>

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.

No

<ConnectionTimeOut>

Specifies the maximum time that a connection can remain open, even if it 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.

No

<Custom>

Specifies the Custom usage type

The usage type specifies the default permission groups and authentication methods that are assigned to the Receive connector. If you use the Custom parameter, you can't use any of the following parameters:

  • Client
  • Internal
  • Internet
  • Partner
  • Usage

    If you specify the Custom parameter, you must specify a value for the following parameters:

  • Bindings
  • RemoteIPRanges

No

<DefaultDomain>

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

No

<DeliveryStatusNotificationEnabled>

Enables or disables the DeliveryStatusNotificationEnabled parameter

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 functionality that is specified in RFC 1891.

No

<DomainController>

Specifies the Fully Qualified Domain Name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service

The DomainController parameter should be included 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.

No

<DomainSecureEnabled>

Enables mutual TLS authentication for the domains that are serviced by this Receive connector. Mutual TLS authentication will function correctly only if the following conditions are true:

  • The value of the DomainSecureEnabled parameter is True.
  • The AuthMechanism parameter contains the value TLS and doesn't contain the value ExternalAuthoritative.
  • The value of the AuthMechanism parameter contains TLS.
  • 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 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.

No

<EightBitMimeEnabled>

Enables or disables EightBitMimeEnabled parameter

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.

No

<EnableAuthGSSAPI>

Controls 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 Microsoft 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 Exchange 2003 servers isn't affected by the value of the EnableAuthGSSAPI parameter. Exchange 2003 servers use the authentication methods that are 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.

The valid input range for this parameter is True or False. The default value is False. By default, the EnableAuthGSSAPI parameter is set to True only on the default Receive connector named "Client <Server Name>" that is created only on Hub Transport servers.

No

<Enabled>

Enables or disables the connector. Valid values for this parameter are True or False. The default value is True.

No

<EnhancedStatusCodesEnabled>

Enables or disables a remote server

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 delivery status notifications (DSNs) that are sent to remote servers.

No

<Fqdn>

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 Transport Layer Security (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.)

NO

<LongAddressesEnabled>

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 1860 characters long after IMCEA encapsulation.

The valid input range for this parameter is True or False. The default value is False. You can only modify this parameter on Receive connectors that are configured on Hub Transport servers.

No

<MaxHeaderSize>

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.

No

<MaxHopCount>

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: header fields that exist in a submitted message. The default value is 30. The valid input range for this parameter is 1 to 500.

No

<MaxInboundConnection>

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

No

<MaxInboundConnectionPercentagePerSource>

Specifies the maximum number of connections that a Receive connector serves at the same time from a single IP address, 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.

No

<MaxInboundConnectionPerSource>

Specifies the maximum number of 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.

No

<MaxLocalHopCount>

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 with local server addresses in a submitted message. The default value is 8. 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.

No

<MaxLogonFailures>

Specifies the number of logon failures that the Receive connector retries before it closes 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 if logon failures.

No

<MaxMessageSize>

Specifies the maximum size of a message

The default value is 10 MB. 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 65536 to 2147483647 bytes.

No

<MaxProtocolErrors>

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

No

<MaxRecipientsPerMessage>

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

No

<MessageRateLimit>

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.

No

<OrarEnabled>

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

The valid input range for this parameter is True or False. The default value is False. If the e-mail address that is specified in the ORAR information is a long X.400 e-mail address, the LongAddressesEnabled parameter must be True.

No

<PermissionGroups>

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.

No

<PipeliningEnabled>

Enables or disables the PipeliningEnabled parameter.

Valid values for this parameter are True or False. 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 waiting for a response from this Receive connector. The default value is True.

No

<ProtocolLoggingLevel>

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.

No

<RequireEHLODomain>

Enables or disables RequireEHLODomain parameter 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.

No

<RequireTLS>

Enables or disables RequireTLS parameter 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 Transport Layer Security (TLS) transmission.

No

<Server>

Specifies the server on which the new Receive connector should be created

No

<SizeEnabled>

Enables or disables the SizeEnabled parameter

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 allowed 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 allowed message size value is never disclosed to the remote server.

When the SizeEnabled
parameter is set to EnabledWithoutValue, the SIZE SMTP extension is enabled. However, the maximum allowed 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.

No

<TarpitInterval>

Specifies the amount 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: dd.hh:mm:ss, where d = days, 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 tarpiting interval.

No

<TemplateInstance>

Create an identical copy of the object on a local or target server

When an existing object is supplied to this parameter, the command uses the configuration of that object to create an identical copy of the object on a local or target server.

No

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*