New-InboundConnector

 

Applies to: Exchange Online, Exchange Online Protection

This cmdlet is available only in the cloud-based service.

Use the New-InboundConnector cmdlet to create a new Inbound connector in your cloud-based organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

New-InboundConnector -Name <String> -SenderDomains <MultiValuedProperty> [-AssociatedAcceptedDomains <MultiValuedProperty>] [-CloudServicesMailEnabled <$true | $false>] [-Comment <String>] [-Confirm [<SwitchParameter>]] [-ConnectorSource <Default | Migrated | HybridWizard | AdminUI>] [-ConnectorType <OnPremises | Partner>] [-Enabled <$true | $false>] [-RequireTls <$true | $false>] [-RestrictDomainsToCertificate <$true | $false>] [-RestrictDomainsToIPAddresses <$true | $false>] [-SenderIPAddresses <MultiValuedProperty>] [-TlsSenderCertificateName <TlsCertificate>] [-TreatMessagesAsInternal <$true | $false>] [-WhatIf [<SwitchParameter>]]

This example creates the Inbound connector named Contoso Inbound Connector with the following properties:

  • It listens for incoming connections from the domain contoso.com and all subdomains.

  • It only accepts mail from contoso.com, and from the IP range 192.168.0.1/25. It rejects mail from contoso.com if it originates from any other IP address.

New-InboundConnector -Name "Contoso Inbound Connector" -SenderDomains *.contoso.com -SenderIPAddresses 192.168.0.1/25 -RestrictDomainstoIPAddresses $true

This example creates the Inbound connector named Contoso Inbound Secure Connector and requires TLS transmission for all messages.

New-InboundConnector -Name "Contoso Inbound Secure Connector" -SenderDomains *.contoso.com -SenderIPAddresses 192.168.0.1/25 -RestrictDomainstoIPAddresses $true -RequireTLS $true -TlsSenderCertificateName *.contoso.com

Inbound connectors accept email messages from remote domains that require specific configuration options.

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 "Inbound and Outbound connectors" entry in the Feature permissions in Exchange Online topic.

 

Parameter Required Type Description

Name

Required

System.String

The Name parameter specifies a descriptive name for the connector.

SenderDomains

Required

Microsoft.Exchange.Data.MultiValuedProperty

The SenderDomains parameter specifies the remote domains from which this connector accepts messages, thereby limiting its scope. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: *.contoso.com. However, you can't embed a wildcard character, as shown in the following example: domain.*.contoso.com. You can specify multiple domains separated by commas.

AssociatedAcceptedDomains

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AssociatedAcceptedDomains parameter specifies the accepted domains that the connector applies to, thereby limiting its scope. For example, you can apply the connector to a specific accepted domain in your organization, such as contoso.com.

CloudServicesMailEnabled

Optional

System.Boolean

Note:   We recommend that you don't use this parameter unless you are directed to do so by Microsoft Customer Service and Support, or by specific product documentation. Instead, use the Hybrid Configuration wizard to configure mail flow between your on-premises and cloud organizations. For more information, see Hybrid Configuration wizard.

The CloudServicesMailEnabled parameter specifies whether the connector is used for hybrid mail flow between an on-premises Exchange environment and Microsoft Office 365. Specifically, this parameter controls how certain internal X-MS-Exchange-Organization-* message headers are handled in messages that are sent between accepted domains in the on-premises and cloud organizations. These headers are collectively known as cross-premises headers.

Valid values are:

  • $true   The connector is used for mail flow in hybrid organizations, so cross-premises headers are preserved or promoted in messages that flow through the connector. This is the default value for connectors that are created by the Hybrid Configuration wizard.

    Preserved for outbound messages   Certain X-MS-Exchange-Organization-* headers in outbound messages that are sent from one side of the hybrid organization to the other are converted to X-MS-Exchange-CrossPremises-* headers and are thereby preserved in messages.

    Promoted for inbound messages   X-MS-Exchange-CrossPremises-* headers in inbound messages that are received on one side of the hybrid organization from the other are promoted to X-MS-Exchange-Organization-* headers. These promoted headers replace any instances of the same X-MS-Exchange-Organization-* headers that already exist in messages.

  • $false   The connector isn't used for mail flow in hybrid organizations, so any cross-premises headers are removed from messages that flow through the connector.

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: "This is an admin note".

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

ConnectorSource

Optional

Microsoft.Exchange.Data.TenantConnectorSource

The ConnectorSource parameter specifies how the connector is created. Valid input for this parameter includes the following values:

  • Default   The connector is manually created.

  • HybridWizard   The connector is automatically created by the Hybrid Configuration Wizard.

  • Migrated   The connector was originally created in Microsoft Forefront Online Protection for Exchange.

The default value for connectors you create yourself is Default. It isn't recommended that you change this value.

ConnectorType

Optional

Microsoft.Exchange.Data.TenantConnectorType

The ConnectorType parameter specifies a category for the domains that are serviced by the connector. Valid input for this parameter includes the following values:

  • Partner   The connector services domains that are external to your organization.

  • OnPremises   The connector services domains that are used by your on-premises organization. Use this value for accepted domains in your cloud-based organization that are also specified by the SenderDomains parameter.

Enabled

Optional

System.Boolean

The Enabled parameter enables or disables the connector. Valid input for this parameter is $true or $false. The default value is $true.

RequireTls

Optional

System.Boolean

The RequireTLS parameter specifies that all messages received by this connector require TLS transmission. Valid values for this parameter are $true or $false. The default value is $false.

RestrictDomainsToCertificate

Optional

System.Boolean

The RestrictDomainsToCertificate parameter, when set to $true, causes the connector to reject mail that originates from a namespace not specified by the SenderDomains parameter.

RestrictDomainsToIPAddresses

Optional

System.Boolean

The RestrictDomainsToIPAddresses parameter, when set to $true, automatically rejects mail from the domains specified by the SenderDomains parameter if the mail originates from an IP address that isn't specified by the SenderIPAddresses parameter.

Valid input for this parameter is $true or $false. The default value is $false.

SenderIPAddresses

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SenderIPAddresses parameter specifies the remote IP addresses from which this connector accepts messages. You enter the IP addresses using the following syntax:

  • Single IP   For example, 192.168.1.1.

  • CIDR IP   You can use Classless InterDomain Routing (CIDR), for example, 192.168.0.1/25.

You can specify multiple IP address separated by commas.

TlsSenderCertificateName

Optional

Microsoft.Exchange.Data.TlsCertificate

The TlsSenderCertificateName parameter specifies the certificate used by the sender's domain when the RequireTls parameter is set to $true. Valid input for the TlsSenderCertificateName parameter is an SMTP domain. You can use a wildcard character to specify all subdomains of a specified domain, as shown in the following example: *.contoso.com.

You can't embed a wildcard character, as shown in the following example: domain.*.contoso.com.

TreatMessagesAsInternal

Optional

System.Boolean

PARAMVALUE: $true | $false

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

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.

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.

 
Show: