Applies to: Exchange Server 2013
Topic Last Modified: 2012-09-13
Use the New-SendConnector cmdlet to create a new Send connector.
Syntax
New-SendConnector -AddressSpaces
<MultiValuedProperty> -Name <String>
[-IsScopedConnector <$true | $false>]
[-AuthenticationCredential <PSCredential>]
[-CloudServicesMailEnabled <$true | $false>] [-Comment
<String>] [-Confirm [<SwitchParameter>]]
[-ConnectionInactivityTimeOut <EnhancedTimeSpan>] [-Custom
<SwitchParameter>] [-DNSRoutingEnabled <$true |
$false>] [-DomainController <Fqdn>] [-DomainSecureEnabled
<$true | $false>] [-Enabled <$true | $false>]
[-ErrorPolicies <Default | DowngradeDnsFailures |
DowngradeCustomFailures>] [-Force <SwitchParameter>]
[-ForceHELO <$true | $false>] [-Fqdn <Fqdn>]
[-FrontendProxyEnabled <$true | $false>] [-IgnoreSTARTTLS
<$true | $false>] [-Internal <SwitchParameter>]
[-Internet <SwitchParameter>] [-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>] [-TlsCertificateName
<SmtpX509Identifier>] [-TlsDomain
<SmtpDomainWithSubdomains>] [-Usage <Custom | Internal |
Internet | Partner>] [-UseExternalDNSServersEnabled <$true |
$false>] [-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example creates the Send connector named MySendConnector with the following properties:
- It sends email messages over the Internet.
- It processes messages addressed only 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 Email to Contoso.com with the following properties:
- It processes messages only 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 email 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 Email to Contoso.com" -AddressSpaces contoso.com -AuthenticationCredential $CredentialObject -SmartHostAuthMechanism BasicAuth |
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 Mail Flow Permissions topic.
Parameters
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 complete syntax for entering each address space is as follows: <AddressSpaceType>:<AddressSpace>;<AddressSpaceCost>
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 in the Transport service on a Mailbox server, you must configure the following parameters:
|
||
Name |
Required |
System.String |
The Name parameter specifies a descriptive name for the connector. |
||
AuthenticationCredential |
Optional |
System.Management.Automation.PSCredential |
The AuthenticationCredential parameter specifies a credential object. This credential object is created by using the Get-Credential cmdlet. For more information about the Get-Credential cmdlet, enter Get-Help Get-Credential in the Exchange Management Shell. |
||
CloudServicesMailEnabled |
Optional |
System.Boolean |
Set to |
||
Comment |
Optional |
System.String |
The Comment parameter specifies an optional comment. If
you specify a value that contains spaces, enclose the value 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 an idle connection can remain open. The default value is ten 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 fifteen minutes, set it to
|
||
Custom |
Optional |
System.Management.Automation.SwitchParameter |
The Custom parameter specifies the
For more information about Send connector usage types, permissions, and authentication methods, see 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. |
||
DomainSecureEnabled |
Optional |
System.Boolean |
The DomainSecureEnabled parameter enables mutual
Transport Layer Security (TLS) authentication for the domains
serviced by the Send connector when set to
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 is |
||
Enabled |
Optional |
System.Boolean |
The Enabled parameter specifies whether to enable the
Send connector to process email messages. Valid values are
|
||
ErrorPolicies |
Optional |
Microsoft.Exchange.Data.ErrorPolicies |
The ErrorPolicies parameter specifies how communication errors are treated. Possible values are the following:
Multiple values can be specified for this parameter, separated by commas. Specify a value other than |
||
Force |
Optional |
System.Management.Automation.SwitchParameter |
The Force switch specifies whether to suppress warning or confirmation messages. This switch can be used when the task is run programmatically and prompting for administrative input is inappropriate. If the Force switch isn't provided in the command, you're prompted for administrative input. You don't have to specify a value with this parameter. |
||
ForceHELO |
Optional |
System.Boolean |
The ForceHELO parameter specifies whether HELO is sent
instead of the default EHLO. Valid values 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
|
||
FrontendProxyEnabled |
Optional |
System.Boolean |
The FrontendProxyEnabled parameter routes outbound
messages through the CAS server, where destination specific
routing, such as DNS or IP address, is set, when the parameter is
set to |
||
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 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 Send Connectors. |
||
IsScopedConnector |
Optional |
System.Boolean |
The IsScopedConnector parameter specifies the
availability of the connector to other Mailbox servers with the
Transport service. When the value of this parameter is
|
||
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 25 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. 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
|
||
Partner |
Optional |
System.Management.Automation.SwitchParameter |
The Partner parameter specifies the
For more information about Send connector usage types, permissions, and authentication methods, see Send Connectors. |
||
Port |
Optional |
System.Int32 |
The Port parameter specifies the port number for smart host forwarding, if you specify a value in the SmartHosts parameter. The valid input range 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. |
||
RequireOorg |
Optional |
System.Boolean |
This 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 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 for authentication with a
remote server. Use this parameter 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 parameteris required if you
set the DNSRoutingEnabled parameter to To enter multiple values and overwrite any existing entries, use
the following syntax:
To add or remove one or more values without affecting any
existing entries, use the following syntax:
|
||
SmtpMaxMessagesPerConnection |
Optional |
System.Int32 |
The SmtpMaxMessagesPerConnection parameter specifies the maximum number of messages the 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 Mailbox servers that can use this Send connector. This parameter isn't valid for Send connectors configured on an Edge server. To enter multiple values and overwrite any existing entries, use
the following syntax:
To add or remove one or more values without affecting any
existing entries, use the following syntax:
|
||
TlsAuthLevel |
Optional |
Microsoft.Exchange.Data.TlsAuthLevel |
The TlsAuthLevel parameter specifies the TLS authentication level that is 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 |
||
TlsCertificateName |
Optional |
Microsoft.Exchange.Data.SmtpX509Identifier |
The TlsCertificateName parameter specifies the combination of the Issuer and Subject attributes of the Certificate Authority (CA) issued X.509 certificate used for secure mail. It is used to help authenticate the local certificate and to minimize the risk of fraudulent certificates. The Issuer portion of the TlsCertificateName value is derived from the certificate Issuer field. The Subject portion of the TlsCertificateName value is derived from the certificate Common Name field. For example, "X509:<I>Issuer<S>Common Name". |
||
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 used only 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 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 Send Connectors. |
||
UseExternalDNSServersEnabled |
Optional |
System.Boolean |
The UseExternalDNSServersEnabled parameter specifies
whether this Send connector uses the external DNS list specified by
the ExternalDNSServers parameter of the
Set-TransportService cmdlet. 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.