Set Send Connector operation


The Set Send Connector process modifies a Send 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 Set Send Connector process.

 Adapter request parameters for Set Send Connector process

Element

Definition

Required

<Identity>

Specifies the GUID or connector name that represents the Send connector that you want to modify

Yes

<AddressSpaces>

Required when the connector is linked to a Receive connector.

If a linked Receive connector is specified using the LinkedReceiveConnector parameter, the value of AddressSpaces is null else, the AddressSpaces parameter specifies the domain names to which the Send connector sends messages. The complete syntax for entering each address space is as follows: <AddressSpaceType>:<AddressSpace>;<AddressSpaceCost>

  • AddressSpaceType (On an Edge Transport server, the address space type is SMTP. On a Hub Transport server, the address space type may be SMTP, X400, or any other text string. If you omit the address space type, an SMTP address space type is assumed.)
  • AddressSpace (For SMTP address space types, the address space that you enter must be RFC 1035-compliant. For example, .com, and *.contoso.com are permitted, but *contoso.com is not permitted. For X.400 address space types, the address space that you enter must be RFC 1685-compliant, such aso=MySite;p=MyOrg;a=adatum;c=us. For all other values of address type, you can enter any text for the address space.)
  • AddressSpaceCost (The valid input range for the cost is 1 to 100. A lower cost indicates a better route. This parameter is optional. If you omit the address space cost, a cost of 1 is assumed. If you enter a non-SMTP address space that contains the semicolon character ( ; ), you must specify the address space cost.If you specify the address space type or the address space cost, you must enclose the address space in double quotation marks ("). For example, the following address space entries are equivalent:
    • "SMTP:contoso.com;1"
    • "contoso.com;1"
    • "SMTP:contoso.com"
    • contoso.com

      You may specify multiple address spaces by separating the address spaces with commas, as follows, for example: contoso.com,fabrikam.com. If you specify the address space type or the address space cost, you must enclose the address space in double quotation marks (") as follows, for example: "contoso.com;2","fabrikam.com;3".

      If you specify a non-SMTP address space type on a Send connector that is configured on a Hub Transport server, the following settings are required on the Send connector:
  • You must use a smart host to route e-mail by specifying a value for the SmartHosts parameter.
  • You must set the DNSRoutingEnabled parameter to False.

No

<Comment>

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

No

<ConnectionInactivityTimeOut>

Specifies the maximum time that an idle connection can remain open

The default value is 10 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 valid input range for this parameter is 00:00:01 to 1.00:00:00.

No

<DNSRoutingEnabled>

Specifies whether Domain Name System (DNS) routing should be used, or if all messages should be sent through the smart host that is configured by using the SmartHosts parameter

The default value is True. If you want to set the value to False, you must first set a value on the SmartHosts parameter.

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 Transport Layer Security (TLS) authentication for the domains that are serviced by this Send connector Mutual TLS authentication will function correctly only when the following conditions are met:

  • The value of the DomainSecureEnabled parameter must be True.
  • The value of the DNSRoutingEnabled parameter must be True.
  • The value of the IgnoreStartTLS parameter must be False. 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 Receive connector, and in the value of the TLSReceiveDomainSecureList parameter in the Get-TransportConfig cmdlet.
  • The default value for DomainSecureEnabled is False for the following types of Send Connectors:
  • All Send connectors that are defined on a Hub Transport Server.
  • User-created Send connectors that are defined on an Edge Transport server. The default value for DomainSecureEnabled is True for the following types of Send Connectors:
    • Default Send connectors that are defined on an Edge Transport server.

No

<Enabled>

Enables or disables the ability for the connector to process e-mail messages Valid input for this parameter is True or False. The default value is True.

No

<Force>

Suppresses the warning or confirmation messages that appear during specific configuration changes

No

<ForceHELO>

Sends a forced value Valid input for this parameter is True or False. The default value is False. By default, EHLO is used. If this parameter is set to True, HELO is sent instead of EHLO.

No

<Fqdn>

Specifies the FQDN that is used as the source server for connected messaging servers that use the Send connector to receive outgoing messages

The value of this parameter is displayed to connected messaging servers whenever a source server name is required, as in the following examples:

  • In the EHLO/HELO command when the Send connector communicates with the next hop messaging server
  • In the most recent Received: header field of the message that is added to the message by the next hop messaging server after the message leaves the Hub Transport server or Edge Transport server
  • During TLS authentication

    The default value of the FQDN parameter is Null. This means the actual default FQDN value is the FQDN of the Hub Transport server or Edge Transport server that contains the Send connector.

No

<IgnoreSTARTTLS>

Specifies whether to ignore the StartTLS option that is offered by a remote sending server

Valid input for this parameter is True or False. This parameter is used with remote domains. This parameter must be set to False if the RequireTLS parameter is set to True.By default, a Send connector with the value of the DNSRoutingEnabled parameter set to True also has the value of the IgnoreStartTLS parameter set to False. This means that the Send connector will always negotiate TLS if TLS is offered by the receiving server. If you set the value of the IgnoreStartTLS parameter to True, the Send connector never tries to negotiate TLS with the receiving server.

No

{{<Instance

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

No

<IsScopedConnector>

Controls the availability of the connector to other Hub Transport servers

When the value of this parameter is False, the connector can be used by all Hub Transport servers in the Exchange organization. When the value of this parameter is True, the connector can only be used by Hub Transport servers in the same Active Directory site. The default value is False.

No

<LinkedReceiveConnector>

Forces all messages that are received by the specified Receive connector through the Send connector

The value of LinkedReceivedConnector can use any of the following identifiers to specify the Receive connector:

  • GUID
  • Distinguished name (DN)
  • Servername\ConnectorName When you use the LinkReceiveConnector parameter with the Set sndConnector cmdlet, you must also use the following parameters with the specified values:
  • AddressSpaces null
  • DNSRoutingEnabled False
  • MaxMessageSize unlimited
  • Smarthosts <SmarthostID>
  • SmarthostAuthMechanism <AuthMechanism>

No

<MaxMessageSize>

Specifies the maximum size of a message that can pass through a connector

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 values are treated as bytes. Values that are entered in bytes are rounded up to nearest kilobyte. For example, 1048575B is rounded up to 1MB, and 1048577 is rounded up to 1025KB. The valid input range for this parameter is 0 to 2147483647 bytes. To remove the message size limit on a Send connector, enter a value of unlimited.

No

{{<Name

Specifies the administrator-supplied name of the connector

You must enclose the Name parameter in double quotation marks if the name contains spaces, as follows, for example: "New Send Connector".

No

<Port>

Specifies the port number

The valid input range for this parameter is an integer between 0 and 65535. The default value is 25. If you specify a value in the SmartHosts parameter, the Port value specifies the port number that is used for smart host forwarding. In most organizations, the port number is set to 25.

No

<ProtocolLoggingLevel>

Enables or disables protocol logging for the specified Send 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

No

RequireTLS

Specifies whether all messages that are sent through this connector must be transmitted by using Transport Layer Security (TLS). The default value is False.

No

<SmartHostAuthMechanism>

Used to authenticate a remote server

This parameter is used only when a smart host is configured and the DNSRoutingEnabled parameter is set to False. Valid values are None, BasicAuth, BasicAuthRequireTLS, ExchangeServer, or ExternalAuthoritative. All values are mutually exclusive. If you select BasicAuth or BasicAuthRequireTLS, you must use the AuthenticationCredential parameter to specify the authentication credential.

No

<SmartHosts>

Takes one or more FQDNs, such as server.contoso.com, or one or more IP addresses, separated by commas

If you enter an IP address, you must enter the IP address as a literal as follows, for example: 10.10.1.1. The smart host identity can be the FQDN of a smart host server, a mail exchange (MX) record, or an address (A) record. If you configure an FQDN as the smart host identity, the source server for the Send connector must be able to use DNS name resolution to locate the smart host server.

No

<SourceIPAddress>

Specifies the local IP address to use as the endpoint for an SMTP connection to a remote messaging server

The default IP address is 0.0.0.0. This value tells the server to use any available local IP address. This parameter is only valid for Send connectors that are configured on Edge Transport servers.

No

<SourceTransportServers>

Specifies the names of the Hub Transport servers that can use this Send connector

You can specify the names of more than one Hub Transport server by separating the names with commas. This parameter is not valid for Send connectors that are configured on Edge Transport servers.

No

<UseExternalDNSServersEnabled>

Specifies whether this Send connector should use the external DNS list that is specified by using the ExternalDNSServers parameter of the Set-TransportServer cmdlet

The default value is False. The valid values of this parameter are True and False.

No

 

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