Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2011-08-30
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.
Syntax
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>] [-ErrorPolicies <Default |
DowngradeAuthFailures | DowngradeDnsFailures>] [-Force
<SwitchParameter>] [-ForceHELO <$true | $false>] [-Fqdn
<Fqdn>] [-IgnoreSTARTTLS <$true | $false>] [-Internal
<SwitchParameter>] [-Internet <SwitchParameter>]
[-IsCoexistenceConnector <$true | $false>]
[-IsScopedConnector <$true | $false>] [-MaxMessageSize
<Unlimited>] [-Partner <SwitchParameter>] [-Port
<Int32>] [-ProtocolLoggingLevel <None | Verbose>]
[-RequireOorg <$true | $false>] [-RequireTLS <$true |
$false>] [-SmartHostAuthMechanism <None | BasicAuth |
BasicAuthRequireTLS | ExchangeServer | ExternalAuthoritative>]
[-SmartHosts <MultiValuedProperty>]
[-SmtpMaxMessagesPerConnection <Int32>] [-SourceIPAddress
<IPAddress>] [-SourceTransportServers
<MultiValuedProperty>] [-TlsAuthLevel <EncryptionOnly |
CertificateValidation | DomainValidation>] [-TlsDomain
<SmtpDomainWithSubdomains>] [-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>]
[-ErrorPolicies <Default | DowngradeAuthFailures |
DowngradeDnsFailures>] [-Force <SwitchParameter>]
[-ForceHELO <$true | $false>] [-Fqdn <Fqdn>]
[-IgnoreSTARTTLS <$true | $false>] [-Internal
<SwitchParameter>] [-Internet <SwitchParameter>]
[-IsCoexistenceConnector <$true | $false>]
[-LinkedReceiveConnector <ReceiveConnectorIdParameter>]
[-MaxMessageSize <Unlimited>] [-Partner
<SwitchParameter>] [-Port <Int32>]
[-ProtocolLoggingLevel <None | Verbose>] [-RequireOorg
<$true | $false>] [-RequireTLS <$true | $false>]
[-SmartHostAuthMechanism <None | BasicAuth | BasicAuthRequireTLS
| ExchangeServer | ExternalAuthoritative>] [-SmartHosts
<MultiValuedProperty>] [-SmtpMaxMessagesPerConnection
<Int32>] [-SourceIPAddress <IPAddress>]
[-SourceTransportServers <MultiValuedProperty>]
[-TlsAuthLevel <EncryptionOnly | CertificateValidation |
DomainValidation>] [-TlsDomain <SmtpDomainWithSubdomains>]
[-Usage <Custom | Internal | Internet | Partner>]
[-UseExternalDNSServersEnabled <$true | $false>] [-WhatIf
[<SwitchParameter>]]
|
Detailed Description
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.
Parameters
Parameter | Required | Type | Description | ||
---|---|---|---|---|---|
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: |
||
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
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:
You may specify multiple address spaces by separating the
address spaces with commas, for example:
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:
|
||
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: |
||
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
|
||
Custom |
Optional |
System.Management.Automation.SwitchParameter |
The Custom parameter specifies the
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 |
||
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 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
The default value for the DomainSecureEnabled parameter
is |
||
Enabled |
Optional |
System.Boolean |
The Enabled parameter specifies whether to enable the
connector to process e-mail messages. Valid values for this
parameter are |
||
ErrorPolicies |
Optional |
Microsoft.Exchange.Data.ErrorPolicies |
The ErrorPolicies parameter specifies how communication errors encountered by this Send connector are treated. The possible values are:
Multiple values can be specified for this parameter, separated by commas. Specify a value other than |
||
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
|
||
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:
The default value of the Fqdn parameter is
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 |
||
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 |
||
Internal |
Optional |
System.Management.Automation.SwitchParameter |
The Internal parameter specifies the
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
For more information about Send connector usage types, permissions, and authentication methods, see Understanding Send Connectors. |
||
IsCoexistenceConnector |
Optional |
System.Boolean |
The IsCoexistenceConnector parameter specifies whether
this Send connector is used for secure mail flow between your
on-premises deployment and your Microsoft Office 365
organization. The default value is |
||
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 |
||
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:
When you use the LinkReceiveConnector parameter with this command, you must also use the following parameters with the specified values:
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:
Unqualified values are treated as bytes. Values entered in bytes
are rounded up to nearest kilobyte. For example,
|
||
Partner |
Optional |
System.Management.Automation.SwitchParameter |
The Partner parameter specifies the
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 |
||
RequireOorg |
Optional |
System.Boolean |
The RequireOorg parameter is reserved for internal Microsoft use. |
||
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 |
||
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
|
||
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
|
||
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 |
||
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. |
||
TlsAuthLevel |
Optional |
Microsoft.Exchange.Data.TlsAuthLevel |
The TlsAuthLevel parameter specifies the TLS authentication level that's used for outbound TLS connections established by this Send connector. Valid values are:
You can't specify a value for this parameter if the
IgnoreSTARTTLS parameter is set to |
||
TlsDomain |
Optional |
Microsoft.Exchange.Data.SmtpDomainWithSubdomains |
The TlsDomain parameter specifies the domain name that the Send connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. This parameter is only used if the TlsAuthLevel parameter
is set to A value for this parameter is required if:
|
||
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: If you use the Usage parameter, you can't use any of the following parameters:
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
|
||
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. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.
Examples
EXAMPLE 1
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.
Copy Code | |
---|---|
New-SendConnector -Internet -Name MySendConnector -AddressSpaces contoso.com,fabrikam.com |
EXAMPLE 2
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.
Copy Code | |
---|---|
$CredentialObject = Get-Credential New-SendConnector -Name "Secure E-Mail to Contoso.com" -AddressSpaces contoso.com -AuthenticationCredential $CredentialObject -SmartHostAuthMechanism BasicAuth |