Applies to: Exchange Server 2013
Topic Last Modified: 2013-01-07
Use the New-ReceiveConnector cmdlet to create a new Receive connector.
Syntax
New-ReceiveConnector -Bindings
<MultiValuedProperty> -RemoteIPRanges
<MultiValuedProperty> [-Custom <SwitchParameter>]
<COMMON PARAMETERS>
|
New-ReceiveConnector -Bindings
<MultiValuedProperty> -Internet <SwitchParameter>
<COMMON PARAMETERS>
|
New-ReceiveConnector -Internal <SwitchParameter>
-RemoteIPRanges <MultiValuedProperty> <COMMON
PARAMETERS>
|
New-ReceiveConnector -Client <SwitchParameter>
-RemoteIPRanges <MultiValuedProperty> <COMMON
PARAMETERS>
|
New-ReceiveConnector -Bindings
<MultiValuedProperty> -Partner <SwitchParameter>
-RemoteIPRanges <MultiValuedProperty> <COMMON
PARAMETERS>
|
New-ReceiveConnector -Usage <Custom | Internet |
Internal | Client | Partner> [-Bindings
<MultiValuedProperty>] [-RemoteIPRanges
<MultiValuedProperty>] <COMMON PARAMETERS>
|
COMMON PARAMETERS: -Name <String>
[-AdvertiseClientSettings <$true | $false>] [-AuthMechanism
<None | Tls | Integrated | BasicAuth | BasicAuthRequireTLS |
ExchangeServer | ExternalAuthoritative>] [-Banner
<String>] [-BinaryMimeEnabled <$true | $false>]
[-Bindings <MultiValuedProperty>] [-ChunkingEnabled <$true
| $false>] [-Comment <String>] [-Confirm
[<SwitchParameter>]] [-ConnectionInactivityTimeout
<EnhancedTimeSpan>] [-ConnectionTimeout
<EnhancedTimeSpan>] [-DefaultDomain
<AcceptedDomainIdParameter>]
[-DeliveryStatusNotificationEnabled <$true | $false>]
[-DomainController <Fqdn>] [-DomainSecureEnabled <$true |
$false>] [-EightBitMimeEnabled <$true | $false>]
[-EnableAuthGSSAPI <$true | $false>] [-Enabled <$true |
$false>] [-EnhancedStatusCodesEnabled <$true | $false>]
[-ExtendedProtectionPolicy <None | Allow | Require>] [-Fqdn
<Fqdn>] [-LiveCredentialEnabled <$true | $false>]
[-LongAddressesEnabled <$true | $false>]
[-MaxAcknowledgementDelay <EnhancedTimeSpan>] [-MaxHeaderSize
<ByteQuantifiedSize>] [-MaxHopCount <Int32>]
[-MaxInboundConnection <Unlimited>]
[-MaxInboundConnectionPercentagePerSource <Int32>]
[-MaxInboundConnectionPerSource <Unlimited>]
[-MaxLocalHopCount <Int32>] [-MaxLogonFailures <Int32>]
[-MaxMessageSize <ByteQuantifiedSize>] [-MaxProtocolErrors
<Unlimited>] [-MaxRecipientsPerMessage <Int32>]
[-MessageRateLimit <Unlimited>] [-MessageRateSource <None
| IPAddress | User | All>] [-OrarEnabled <$true | $false>]
[-PermissionGroups <None | AnonymousUsers | ExchangeUsers |
ExchangeServers | ExchangeLegacyServers | Partners | Custom>]
[-PipeliningEnabled <$true | $false>] [-ProtocolLoggingLevel
<None | Verbose>] [-ProxyEnabled <$true | $false>]
[-RemoteIPRanges <MultiValuedProperty>] [-RequireEHLODomain
<$true | $false>] [-RequireTLS <$true | $false>]
[-Server <ServerIdParameter>] [-ServiceDiscoveryFqdn
<Fqdn>] [-SizeEnabled <Disabled | Enabled |
EnabledWithoutValue>] [-SuppressXAnonymousTls <$true |
$false>] [-TarpitInterval <EnhancedTimeSpan>]
[-TlsCertificateName <SmtpX509Identifier>]
[-TlsDomainCapabilities <MultiValuedProperty>]
[-TransportRole <None | Cafe | Mailbox | ClientAccess |
UnifiedMessaging | HubTransport | Edge | All | Monitoring |
CentralAdmin | CentralAdminDatabase | DomainController |
WindowsDeploymentServer | ProvisionedServer | LanguagePacks |
FrontendTransport | CafeArray | FfoWebService | OSP | ARR |
ManagementFrontEnd | ManagementBackEnd | SCOM>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example creates the custom Receive connector Test with the following properties:
- It listens for incoming SMTP connections on the IP address
10.10.1.1 and port 25.
- It accepts incoming SMTP connections only from the IP range
192.168.0.1-192.168.0.24
Copy Code | |
---|---|
New-ReceiveConnector -Name Test -Usage Custom -Bindings 10.10.1.1:25 -RemoteIPRanges 192.168.0.1-192.168.0.24 |
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 "Receive connectors" entry in the Mail Flow Permissions topic.
Parameters
Parameter | Required | Type | Description | ||
---|---|---|---|---|---|
Bindings |
Required |
Microsoft.Exchange.Data.MultiValuedProperty |
The Bindings parameter specifies the local IP address and
TCP port number used by the Receive connector to listen for inbound
messages. Valid syntax for this parameter is
<IP Address>:<TCP Port>, such
as
You must specify a value for the Bindings parameter when the following parameters are specified:
The values that you specify using the Bindings parameter must satisfy one of the following requirements for uniqueness:
You can't specify a value for the Bindings parameter with this command when the following parameters are specified:
|
||
Client |
Required |
System.Management.Automation.SwitchParameter |
The Client parameter specifies the
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, this command prompts you so that it may continue. For more information about Receive connector usage types, permission groups, and authentication methods, see Receive Connectors. |
||
Internal |
Required |
System.Management.Automation.SwitchParameter |
The Internal parameter specifies the
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 command prompts you so that it may continue. For more information about Receive connector usage types, permission groups, and authentication methods, see Receive Connectors. |
||
Internet |
Required |
System.Management.Automation.SwitchParameter |
The Internet parameter specifies the
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, this command prompts you so that it may continue. For more information about Receive connector usage types, permission groups, and authentication methods, see Receive Connectors. |
||
Name |
Required |
System.String |
The Name parameter specifies the administrator-supplied
name of the connector. Enter the Name parameter as a string,
for example: |
||
Partner |
Required |
System.Management.Automation.SwitchParameter |
The Partner parameter specifies the
If you specify the Partner parameter, you must specify a value for the following parameters:
If you don't provide a value for a required parameter, this command prompts you so that it may continue. |
||
RemoteIPRanges |
Required |
Microsoft.Exchange.Data.MultiValuedProperty |
The RemoteIPRanges parameter 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 You must specify a value for the RemoteIPRanges parameter when the following parameters are specified:
Multiple 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. The default value of the RemoteIPRanges parameter for the
|
||
Usage |
Required |
Microsoft.Exchange.Management.SystemConfigurationTasks.NewReceiveConnector+UsageType |
The Usage parameter specifies the default permission
groups and authentication methods assigned to the Receive
connector. The valid values for the Usage parameter are as
follows: If you specify a value for the Usage parameter, you can't use any of the following parameters:
A value for the Bindings parameter is required if you specify any of the following values for the Usage parameter:
A value for the RemoteIPRanges parameter is required if you specify any of the following values for the Usage parameter:
If you don't specify a value for a required parameter, the command ends unsuccessfully. This command won't prompt you for the missing required parameters. For more information about Receive connector usage types, permission groups, and authentication methods, see Receive Connectors. |
||
AdvertiseClientSettings |
Optional |
System.Boolean |
The AdvertiseClientSettings parameter specifies whether the SMTP server name, port number, and authentication settings are displayed in the Outlook Web App, accessed from Settings > Options > Account > my Account > Settings for POP or IMAP access. The default value is |
||
AuthMechanism |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.ReceiveConnector+AuthMechanisms |
The AuthMechanism parameter specifies the advertised and
accepted authentication mechanisms. The authentication options are
|
||
Banner |
Optional |
System.String |
The Banner parameter specifies an SMTP 220 banner and overrides the default SMTP 220 banner. When the value of the Banner parameter is blank, the default SMTP banner is the following:
When you specify a value for the Banner parameter, you must use the following syntax:
220 is the default Service ready SMTP response code as defined in RFC 2821. |
||
BinaryMimeEnabled |
Optional |
System.Boolean |
The BinaryMimeEnabled parameter specifies whether the
BINARYMIME EHLO keyword is advertised in the EHLO response to the
remote server and is available for use. Valid values for this
parameter are |
||
ChunkingEnabled |
Optional |
System.Boolean |
The ChunkingEnabled parameter specifies whether the
CHUNKING EHLO keyword is advertised in the EHLO response to the
remote server and is available for use. Valid input for this
parameter is |
||
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 amount of idle time before a connection to a Receive connector is closed. The default value for a Receive connector configured on a Mailbox server is 5 minutes. The default value for a Receive connector configured on an Edge server is 1 minute. To specify a value, enter it 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 |
||
ConnectionTimeout |
Optional |
Microsoft.Exchange.Data.EnhancedTimeSpan |
The ConnectionTimeout parameter specifies the maximum time that a connection can remain open, even if the connection is actively transmitting data. The default value for a Receive connector configured on a Mailbox server is 10 minutes. The default value for a Receive connector configured on an Edge server is 5 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 a connection time-out of 5 minutes,
enter 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 from |
||
Custom |
Optional |
System.Management.Automation.SwitchParameter |
The Custom parameter specifies the
If you specify the Custom parameter, you must specify a value for the following parameters:
If you don't provide a value for a required parameter, this command prompts you so that it may continue. |
||
DefaultDomain |
Optional |
Microsoft.Exchange.Configuration.Tasks.AcceptedDomainIdParameter |
The DefaultDomain parameter specifies the domain name to
append to values that are submitted to |
||
DeliveryStatusNotificationEnabled |
Optional |
System.Boolean |
The DeliveryStatusNotificationEnabled parameter specifies
whether the delivery status notification (DSN) EHLO keyword is
advertised in the EHLO response to the remote server and is
available for use. 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 this Receive connector. Mutual TLS authentication functions correctly only if the following conditions are true:
The default value for the DomainSecureEnabled parameter
is
The default value for the DomainSecureEnabled parameter
is |
||
EightBitMimeEnabled |
Optional |
System.Boolean |
The EightBitMimeEnabled parameter specifies whether the
8BITMIME EHLO keyword is advertised in the EHLO response to the
remote server and is available for use. Valid values for this
parameter are |
||
EnableAuthGSSAPI |
Optional |
System.Boolean |
The EnableAuthGSSAPI parameter specifies 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
If you have Internet Information Services (IIS) messaging
servers that authenticate with this Receive connector, you should
set the value of the EnableAuthGSSAPI parameter to
The valid values for this parameter is |
||
Enabled |
Optional |
System.Boolean |
The Enabled parameter specifies whether to enable the
connector. Valid values for this parameter are |
||
EnhancedStatusCodesEnabled |
Optional |
System.Boolean |
The EnhancedStatusCodesEnabled parameter specifies
whether the ENHANCEDSTATUSCODES EHLO keyword is advertised in the
EHLO response to the remote server and is available for use. Valid
values for this parameter are |
||
ExtendedProtectionPolicy |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.ReceiveConnector+ExtendedProtectionPolicySetting |
The ExtendedProtectionPolicy parameter specifies how
Extended Protection for Authentication is implemented on this
Receive connector. By default, this parameter is set to
Extended Protection for Authentication enhances the protection and handling of credentials when authenticating network connections using Integrated Windows authentication. Integrated Windows authentication is also known as NTLM. We strongly recommend that you use Extended Protection for Authentication if you are using Integrated Windows authentication. |
||
Fqdn |
Optional |
Microsoft.Exchange.Data.Fqdn |
The Fqdn parameter specifies the FQDN 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:
The default value of the Fqdn parameter is the FQDN of the Mailbox server or Edge server that contains the Receive connector.
|
||
LiveCredentialEnabled |
Optional |
System.Boolean |
Reserved for internal Microsoft use. |
||
LongAddressesEnabled |
Optional |
System.Boolean |
The LongAddressesEnabled parameter specifies whether the Receive connector accepts long X.400 email addresses. The X.400 email addresses are encapsulated in SMTP email addresses by using the Internet Mail Connector Encapsulated Address (IMCEA) encapsulation method. When the value of this parameter is When the value of this parameter is
Therefore, X.400 email addresses can be up to 1,860 characters long after IMCEA encapsulation. The valid values for this parameter are |
||
MaxAcknowledgementDelay |
Optional |
Microsoft.Exchange.Data.EnhancedTimeSpan |
This parameter isn't used by Microsoft Exchange Server 2013. It's only used by Microsoft Exchange 2010 servers in a coexistence environment. The MaxAcknowledgementDelay parameter specifies the maximum period the transport server delays acknowledgement until it verifies that the message has been successfully delivered to all recipients. When receiving messages from a host that doesn't support shadow redundancy, an Exchange Server 2010 transport server will delay issuing an acknowledgement until it verifies that the message has been successfully delivered to all recipients. However, if it takes too long to verify successful delivery, the transport server will time out and issue an acknowledgement anyway. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds. The default value is 30 seconds. |
||
MaxHeaderSize |
Optional |
Microsoft.Exchange.Data.ByteQuantifiedSize |
The MaxHeaderSize parameter 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:
Unqualified values are treated as bytes. The valid input range for this parameter is from 1 through 2147483647 bytes. |
||
MaxHopCount |
Optional |
System.Int32 |
The MaxHopCount parameter 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 |
||
MaxInboundConnection |
Optional |
Microsoft.Exchange.Data.Unlimited |
The MaxInboundConnection parameter 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 from 1 through 2147483647. To disable the inbound
connection limit on a Receive connector, enter a value of
|
||
MaxInboundConnectionPercentagePerSource |
Optional |
System.Int32 |
The MaxInboundConnectionPercentagePerSource parameter 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 sign (%). The default value is 2 percent. The valid input range for this parameter is 1 to 100. |
||
MaxInboundConnectionPerSource |
Optional |
Microsoft.Exchange.Data.Unlimited |
The MaxInboundConnectionPerSource parameter 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 from 1 through 10000.
To disable the inbound connection per source limit on a Receive
connector, enter a value of |
||
MaxLocalHopCount |
Optional |
System.Int32 |
The MaxLocalHopCount parameter 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 |
||
MaxLogonFailures |
Optional |
System.Int32 |
The MaxLogonFailures parameter 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 from 0 through 10. When you specify a value of 0, the connection is never closed because of logon failures. |
||
MaxMessageSize |
Optional |
Microsoft.Exchange.Data.ByteQuantifiedSize |
The MaxMessageSize parameter specifies the maximum size of a message. 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. The valid input range for this parameter is from 65536 through 2147483647 bytes. |
||
MaxProtocolErrors |
Optional |
Microsoft.Exchange.Data.Unlimited |
The MaxProtocolErrors parameter 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 from 0 through 2147483647. When
you specify a value of |
||
MaxRecipientsPerMessage |
Optional |
System.Int32 |
The MaxRecipientsPerMessage parameter 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. |
||
MessageRateLimit |
Optional |
Microsoft.Exchange.Data.Unlimited |
The MessageRateLimit parameter 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 configured on
a Mailbox server is |
||
MessageRateSource |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.MessageRateSourceFlags |
The MessageRateSource parameter specifies how the message submission rate is calculated. It can have one of the following values:
|
||
OrarEnabled |
Optional |
System.Boolean |
The OrarEnabled parameter enables the Originator
Requested Alternate Recipient (ORAR). When the value of this
parameter is The valid values for this parameter are |
||
PermissionGroups |
Optional |
Microsoft.Exchange.Data.PermissionGroups |
The PermissionGroups parameter specifies the groups or
roles that can submit messages to the Receive connector and the
permissions assigned to those groups. A permission group is a
predefined set of permissions granted to well-known security
principals. The valid values for this parameter are as follows:
|
||
PipeliningEnabled |
Optional |
System.Boolean |
The PipeliningEnabled parameter specifies whether the
PIPELINING EHLO keyword is advertised in the EHLO response to the
remote server and is available for use. Valid values for this
parameter are |
||
ProtocolLoggingLevel |
Optional |
Microsoft.Exchange.Data.ProtocolLoggingLevel |
The ProtocolLoggingLevel parameter specifies whether to
enable or disable protocol logging for a Receive connector. A value
of |
||
ProxyEnabled |
Optional |
System.Boolean |
This parameter is reserved for internal Microsoft use. |
||
RequireEHLODomain |
Optional |
System.Boolean |
The RequireEHLODomain parameter specifies whether the
remote computer must provide a domain name in the EHLO handshake
after the SMTP connection is established. Valid values for this
parameter are |
||
RequireTLS |
Optional |
System.Boolean |
The RequireTLS parameter specifies that all messages
received by this connector require TLS transmission. Valid values
for this parameter are |
||
Server |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The Server parameter specifies the server on which the new Receive connector is created. |
||
ServiceDiscoveryFqdn |
Optional |
Microsoft.Exchange.Data.Fqdn |
The service discovery fully-qualified domain name (FQDN). |
||
SizeEnabled |
Optional |
Microsoft.Exchange.Data.SizeMode |
The SizeEnabled parameter specifies whether the SIZE SMTP
extension is enabled. Valid values for this parameter are
|
||
SuppressXAnonymousTls |
Optional |
System.Boolean |
The SuppressXAnonymousTls parameter specifies whether
this Receive connector supports the standard TLS encryption for
incoming connections. By default, all communications between
servers is protected with TLS. However, if you need to disable TLS
on a specific connection in your organization, you can create a
specific Receive connector and set the SuppressXAnonymousTls
parameter to Before you can set this parameter to |
||
TarpitInterval |
Optional |
Microsoft.Exchange.Data.EnhancedTimeSpan |
The TarpitInterval parameter specifies the amount of time to delay an SMTP response to a remote server that may be abusing the connection. Authenticated connections are never delayed in this manner. The default value is 5 seconds. To specify a value, enter it 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 from
|
||
TlsCertificateName |
Optional |
Microsoft.Exchange.Data.SmtpX509Identifier |
The TlsCertificateName parameter specifies the local Certificate Authority (CA) issued certificate to use for secure mail. It helps minimize the risk of fraudulent certificates. The Issuer portion of the TlsCertificateName value is derived from the certificate Issuer field and the Subject portion of the TlsCertificateName value is derived from the certificate Common Name field. For example, “X509:<I>Issuer<S>Common Name”. |
||
TlsDomainCapabilities |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The TlsDomainCapabilities parameter specifies the capabilities this Receive connector will make available to specific hosts outside your organization. TLS with certificate validation is used to authenticate remote hosts before these capabilities are offered. To specify capabilities for a domain, use the following syntax: <domain name 1>:<capability 1, capability 2,…,capability N> If you're specifying capabilities for multiple domains, list the configuration for each domain in quotation marks ("), separated by commas. For example: "contoso.com:AcceptOorgProtocol","fabrikam.com:AcceptOorgProtocol,AcceptOorgHeader" You can configure the capabilities for non-TLS encrypted incoming connections using the special "NO-TLS" domain. You can configure the following capabilities for a domain:
|
||
TransportRole |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.ServerRole |
The TransportRole parameter designates the server role
associated with this connector. Types include
|
||
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.