Export (0) Print
Expand All

New-SendConnector

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

Use the New-SendConnector cmdlet to create a new Send connector on a computer that has the Hub Transport server role or the Edge Transport server role installed.


New-SendConnector -Name <String> -AddressSpaces <MultiValuedProperty> [-AuthenticationCredential <PSCredential>] [-Comment <String>] [-Confirm [<SwitchParameter>]] [-ConnectionInactivityTimeOut <EnhancedTimeSpan>] [-Custom <SwitchParameter>] [-DNSRoutingEnabled <$true | $false>] [-DomainController <Fqdn>] [-DomainSecureEnabled <$true | $false>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-ForceHELO <$true | $false>] [-Fqdn <Fqdn>] [-IgnoreSTARTTLS <$true | $false>] [-Internal <SwitchParameter>] [-Internet <SwitchParameter>] [-IsScopedConnector <$true | $false>] [-MaxMessageSize <Unlimited>] [-Partner <SwitchParameter>] [-Port <Int32>] [-ProtocolLoggingLevel <None | Verbose>] [-RequireTLS <$true | $false>] [-SmartHostAuthMechanism <None | BasicAuth | BasicAuthRequireTLS | ExchangeServer | ExternalAuthoritative>] [-SmartHosts <MultiValuedProperty>] [-SmtpMaxMessagesPerConnection <Int32>] [-SourceIPAddress <IPAddress>] [-SourceTransportServers <MultiValuedProperty>] [-Usage <Custom | Internal | Internet | Partner>] [-UseExternalDNSServersEnabled <$true | $false>] [-WhatIf [<SwitchParameter>]]


New-SendConnector -Name <String> [-AuthenticationCredential <PSCredential>] [-Comment <String>] [-Confirm [<SwitchParameter>]] [-ConnectionInactivityTimeOut <EnhancedTimeSpan>] [-Custom <SwitchParameter>] [-DNSRoutingEnabled <$true | $false>] [-DomainController <Fqdn>] [-DomainSecureEnabled <$true | $false>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-ForceHELO <$true | $false>] [-Fqdn <Fqdn>] [-IgnoreSTARTTLS <$true | $false>] [-Internal <SwitchParameter>] [-Internet <SwitchParameter>] [-LinkedReceiveConnector <ReceiveConnectorIdParameter>] [-MaxMessageSize <Unlimited>] [-Partner <SwitchParameter>] [-Port <Int32>] [-ProtocolLoggingLevel <None | Verbose>] [-RequireTLS <$true | $false>] [-SmartHostAuthMechanism <None | BasicAuth | BasicAuthRequireTLS | ExchangeServer | ExternalAuthoritative>] [-SmartHosts <MultiValuedProperty>] [-SmtpMaxMessagesPerConnection <Int32>] [-SourceIPAddress <IPAddress>] [-SourceTransportServers <MultiValuedProperty>] [-Usage <Custom | Internal | Internet | Partner>] [-UseExternalDNSServersEnabled <$true | $false>] [-WhatIf [<SwitchParameter>]]

Parameter Required Type Description

AddressSpaces

Required

Microsoft.Exchange.Data.MultiValuedProperty

The AddressSpaces parameter specifies the domain names to which the Send connector routes mail. The AddressSpaces parameter is required unless this connector is linked to a Receive connector. If a linked Receive connector is specified by using the LinkedReceiveConnector parameter, the value of the AddressSpaces parameter must be $null. The complete syntax for entering each address space is as follows: <AddressSpaceType>:<AddressSpace>;<AddressSpaceCost>

  • AddressSpaceType   On an Edge Transport server, the address space type must be 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 isn't permitted. For X.400 address space types, the address space that you enter must be RFC 1685-compliant, such as o=MySite;p=MyOrg;a=adatum;c=us. For all other values of address space type, you can enter any text for the address space.
  • AddressSpaceCost   The valid input range for the cost is from 1 through 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 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, 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 quotation marks ("), for example: "contoso.com;2","fabrikam.com;3".

If you specify a non-SMTP address space type on a Send connector 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.
Aa998936.note(en-us,EXCHG.140).gifNote:
Although you can configure non-SMTP address spaces on a Send connector on a Hub Transport server, the Send connector uses SMTP as the transport mechanism to send messages to other messaging servers. Foreign connectors on Hub Transport servers are used to send messages to local messaging servers, such as third-party fax gateway servers, which don't use SMTP as their primary transport mechanism. For more information, see Understanding Foreign Connectors.

Name

Required

System.String

The Name parameter is the administrator-supplied name of the connector. You must enclose the value of the Name parameter in quotation marks (") if the name contains spaces, for example: "New Send Connector".

AuthenticationCredential

Optional

System.Management.Automation.PSCredential

The AuthenticationCredential parameter specifies the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information about the Get-Credential cmdlet, type Get-Help Get-Credential in the Exchange Management Shell.

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 time that an idle connection can remain open. The default value is 10 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 15 minutes for this parameter, use 00:15:00. The valid input range for this parameter is from 00:00:01 through 1.00:00:00.

Custom

Optional

System.Management.Automation.SwitchParameter

The Custom parameter specifies the Custom usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Custom parameter, you can't use any of the following parameters:

  • Internal
  • Internet
  • Partner
  • Usage

For more information about Send connector usage types, permissions, and authentication methods, see Understanding Send Connectors.

DNSRoutingEnabled

Optional

System.Boolean

The DNSRoutingEnabled parameter specifies whether the Send connector uses Domain Name System (DNS) to route mail. Valid values for this parameter are $true or $false. The default value is $true. If you specify a SmartHosts parameter, the DNSRoutingEnabled parameter must be $false on the same command line.

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 part of the process to enable mutual Transport Layer Security (TLS) authentication for the domains serviced by this Send connector. Mutual TLS authentication functions correctly only if the following conditions are true:

  • The value of the DomainSecureEnabled parameter is set to $true.
  • The value of the DNSRoutingEnabled parameter is set to $true.
  • The value of the IgnoreSTARTTLS parameter is set to $false.

The wildcard character (*) isn't supported in domains configured for mutual TLS authentication. The same domain must also be defined on the corresponding Receive connector, and in the value of the TLSReceiveDomainSecureList attribute of the transport configuration.

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

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

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

Enabled

Optional

System.Boolean

The Enabled parameter specifies whether to enable the connector to process e-mail messages. Valid values for this parameter are $true or $false. The default value is $true.

Force

Optional

System.Management.Automation.SwitchParameter

The Force parameter specifies whether to suppress the warning or confirmation messages that appear during specific configuration changes.

ForceHELO

Optional

System.Boolean

The ForceHELO parameter specifies whether HELO is sent instead of EHLO. Valid values for this parameter are $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.

Fqdn

Optional

Microsoft.Exchange.Data.Fqdn

The Fqdn parameter specifies the FQDN 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 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.

If the Send connector is configured on a Hub Transport server that also has the Mailbox server role installed, any value that you specify for the Fqdn parameter isn't used. Instead, the FQDN of the server displayed by using the Get-ExchangeServer cmdlet is always used.

For servers that have both the Hub Transport server role and the Mailbox server role installed, the only way to remove the server name from the Received headers of the outgoing message is to use the Remove-ADPermission cmdlet to remove the Ms-Exch-Send-Headers-Routing permission from the security principals that use the connector. This action removes all the Received headers from the message as the message leaves the Hub Transport server. We recommend that you don't remove the Received headers for internal messages, because the Received headers are used for maximum hop count calculations. For more information about the Remove-ADPermission cmdlet and the Get-ExchangeServer cmdlet, see the following topics:

IgnoreSTARTTLS

Optional

System.Boolean

The IgnoreSTARTTLS parameter specifies whether to ignore the StartTLS option offered by a remote sending server. This parameter is used with remote domains. This parameter must be set to $false if the RequireTLS parameter is set to $true. The valid values for this parameter are $true or $false.

Internal

Optional

System.Management.Automation.SwitchParameter

The Internal parameter specifies the Internal usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internal parameter, you can't use any of the following parameters:

  • Custom
  • Internet
  • Partner
  • Usage

For more information about Send connector usage types, permissions, and authentication methods, see Understanding Send Connectors.

Internet

Optional

System.Management.Automation.SwitchParameter

The Internet parameter specifies the Internet usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Internet parameter, you can't use any of the following parameters:

  • Custom
  • Internal
  • Partner
  • Usage

For more information about Send connector usage types, permissions, and authentication methods, see Understanding Send Connectors.

IsScopedConnector

Optional

System.Boolean

The IsScopedConnector parameter specifies 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.

LinkedReceiveConnector

Optional

Microsoft.Exchange.Configuration.Tasks.ReceiveConnectorIdParameter

The LinkedReceiveConnector parameter specifies whether to force all messages received by the specified Receive connector out through this 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 this command, you must also use the following parameters with the specified values:

  • DNSRoutingEnabled $false
  • MaxMessageSize unlimited
  • Smarthosts <SmarthostID>
  • SmarthostAuthMechanism <AuthMechanism>

When you use the LinkedReceiveConnector parameter, you can't use the AddressSpaces parameter.

MaxMessageSize

Optional

Microsoft.Exchange.Data.Unlimited

The MaxMessageSize parameter specifies the maximum size of a message that can pass through a connector. 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. Values 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 from 0 through 2147483647 bytes. To remove the message size limit on a Send connector, enter a value of unlimited.

Partner

Optional

System.Management.Automation.SwitchParameter

The Partner parameter specifies the Partner usage type. The usage type specifies the permissions and authentication methods assigned to the Send connector. If you use the Partner parameter, you can't use any of the following parameters:

  • Custom
  • Internal
  • Internet
  • Usage

For more information about Send connector usage types, permissions, and authentication methods, see Understanding Send Connectors.

Port

Optional

System.Int32

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

ProtocolLoggingLevel

Optional

Microsoft.Exchange.Data.ProtocolLoggingLevel

The ProtocolLoggingLevel parameter specifies whether to enable 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 location of the Send connector protocol logs for all Send connectors configured on a Hub Transport server or an Edge Transport server is specified by using the Set-TransportServer cmdlet SendProtocolLogPath parameter.

RequireTLS

Optional

System.Boolean

The RequireTLS parameter specifies whether all messages sent through this connector must be transmitted by using TLS. The default value is $false.

SmartHostAuthMechanism

Optional

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

The SmartHostAuthMechanism parameter specifies the smart host authentication mechanism to use during authentication with 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, and ExternalAuthoritative. All values are mutually exclusive. If you select BasicAuth or BasicAuthRequireTLS, you must use the AuthenticationCredential parameter to specify the authentication credential.

SmartHosts

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SmartHosts parameter specifies the smart hosts the Send connector uses to route mail. This parameter is required if you set the DNSRoutingEnabled parameter to $false and must be specified on the same command line. The SmartHosts parameter takes one or more FQDNs, such as server.contoso.com, or one or more IP addresses, or a combination of both FQDNs and IP addresses. Separate each value by using a comma. If you enter an IP address, you must enter the IP address as a literal, 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.

SmtpMaxMessagesPerConnection

Optional

System.Int32

The SmtpMaxMessagesPerConnection parameter specifies the maximum number of messages this Send connector server can send per connection.

SourceIPAddress

Optional

System.Net.IPAddress

The SourceIPAddress parameter 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 means that the server can use any available local IP address. This parameter is only valid for Send connectors configured on Edge Transport servers.

SourceTransportServers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SourceTransportServers parameter 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 isn't valid for Send connectors configured on Edge Transport servers.

Usage

Optional

Microsoft.Exchange.Management.SystemConfigurationTasks.NewSendConnector+UsageType

The Usage parameter specifies the default permissions and authentication methods assigned to the Send connector. The valid values for this parameter are as follows: Custom, Internal, Internet, or Partner. If you don't specify a value for the Usage parameter, the usage type defaults to Custom.

If you use the Usage parameter, you can't use any of the following parameters:

  • Custom
  • Internal
  • Internet
  • Partner

For more information about Send connector usage types, permissions, and authentication methods, see Understanding Send Connectors.

UseExternalDNSServersEnabled

Optional

System.Boolean

The UseExternalDNSServersEnabled parameter specifies whether this Send connector should use the external DNS list specified by using the Set-TransportServer cmdlet ExternalDNSServers parameter. The default value is $false. The valid values of this parameter are $true or $false.

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.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Send connectors" entry in the Transport Permissions topic.

This example creates the Send connector MySendConnector with the following properties:

  • It sends e-mail messages over the Internet.
  • It only processes messages addressed to Contoso.com and Fabrikam.com domains.
New-SendConnector -Internet -Name MySendConnector -AddressSpaces contoso.com,fabrikam.com

This example creates the Send connector Secure E-Mail to Contoso.com with the following properties:

  • It only processes messages for the Contoso.com domain.
  • It uses Basic authentication.
  • It uses a specific authentication credential.

To assign a specific authentication credential for the Send connector, you must first run the Get-Credential command and store the user input in a temporary variable. When you run the Get-Credential command, the command asks for the user name and password of the account used during authentication with the Contoso.com e-mail server. The temporary variable can then be used in the New-SendConnector cmdlet to create the new connector.

$CredentialObject = Get-Credential
New-SendConnector -Name "Secure E-Mail to Contoso.com" -AddressSpaces contoso.com -AuthenticationCredential $CredentialObject -SmartHostAuthMechanism BasicAuth
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft