Set-OutboundConnector

 

Applies to: Exchange Online, Exchange Online Protection

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

Use the Set-OutboundConnector cmdlet to modify an existing Outbound connector in your cloud-based organization.

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

Set-OutboundConnector -Identity <OutboundConnectorIdParameter> [-AllAcceptedDomains <$true | $false>] [-CloudServicesMailEnabled <$true | $false>] [-Comment <String>] [-Confirm [<SwitchParameter>]] [-ConnectorSource <Default | Migrated | HybridWizard | AdminUI>] [-ConnectorType <OnPremises | Partner>] [-Enabled <$true | $false>] [-IsTransportRuleScoped <$true | $false>] [-IsValidated <$true | $false>] [-LastValidationTimestamp <DateTime>] [-Name <String>] [-RecipientDomains <MultiValuedProperty>] [-RouteAllMessagesViaOnPremises <$true | $false>] [-SmartHosts <MultiValuedProperty>] [-TestMode <$true | $false>] [-TlsDomain <SmtpDomainWithSubdomains>] [-TlsSettings <EncryptionOnly | CertificateValidation | DomainValidation>] [-UseMXRecord <$true | $false>] [-ValidationRecipients <String[]>] [-WhatIf [<SwitchParameter>]]

This example changes the settings of the existing Outbound connector named Contoso Outbound Connector to route to a smart host at IP address 192.168.0.1.

Set-OutboundConnector "Contoso Outbound Connector" -UseMxRecord $false -SmartHosts 192.168.0.1

Outbound connectors send email messages to 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

Identity

Required

Microsoft.Exchange.Configuration.Tasks.OutboundConnectorIdParameter

The Identity parameter specifies the connector you want to modify.

AllAcceptedDomains

Optional

System.Boolean

When this parameter is set to $true, the connector applies to all accepted domains.

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.

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.

IsTransportRuleScoped

Optional

System.Boolean

The IsTransportRuleScoped parameter associates the Outbound connector with a transport rule. Valid input for this parameter is $true or $false.

A transport rule is scoped to a specific Outbound connector using the RouteMessageOutboundConnector parameter on the New-TransportRule or Set-TransportRule cmdlets. Messages that match the conditions of the transport rule are routed to their destinations using the specified Outbound connector.

IsValidated

Optional

System.Boolean

PARAMVALUE: $true | $false

LastValidationTimestamp

Optional

System.DateTime

PARAMVALUE: DateTime

Name

Optional

System.String

The Name parameter specifies a descriptive name for the connector.

RecipientDomains

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RecipientDomains parameter specifies the domain names to which the Outbound connector routes mail. 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.

RouteAllMessagesViaOnPremises

Optional

System.Boolean

The RouteAllMessagesViaOnPremises parameter indicates all messages serviced by this connector are first routed through the on-premises messaging system. Valid input for this parameter is $true or $false. The default value is $false. If you set RouteAllMessagesViaOnPremises to $true, you must set the value of the ConnectorType parameter to OnPremises in the same command.

SmartHosts

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SmartHosts parameter specifies the smart hosts the Outbound connector uses to route mail. This parameter is required if you set the UseMxRecord 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 may enter the IP address as a literal, for example: 10.10.1.1, or using Classless InterDomain Routing (CIDR), for example, 192.168.0.1/25. The smart host identity can be the FQDN of a smart host server, a mail exchange (MX) record, or an address (A) record.

TestMode

Optional

System.Boolean

PARAMVALUE: $true | $false

TlsDomain

Optional

Microsoft.Exchange.Data.SmtpDomainWithSubdomains

The TlsDomain parameter specifies the domain name that the Outbound connector uses to verify the FQDN of the target certificate when establishing a TLS secured connection. This parameter is only used if the TlsSettings parameter is set to DomainValidation. Valid input for the TlsDomain 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. However, you can't embed a wildcard character, as shown in the following example: domain.*.contoso.com

TlsSettings

Optional

Microsoft.Exchange.Data.TlsAuthLevel

The TlsSettings parameter specifies the TLS authentication level that's used for outbound TLS connections established by this Outbound connector. Valid values are:

  • EncryptionOnly   TLS is used only to encrypt the communication channel. No certificate authentication is performed.

  • CertificateValidation   TLS is used to encrypt the channel and certificate chain validation and revocation lists checks are performed.

  • DomainValidation   In addition to channel encryption and certificate validation, the Outbound connector also verifies that the FQDN of the target certificate matches the domain specified in the TlsDomain parameter.

UseMXRecord

Optional

System.Boolean

The UseMXRecord parameter enables or disables DNS routing for the connector. Valid input for this parameter is $true or $false. The default value is $true. To bypass DNS routing and use a smart host as the destination for the connector, set the value of UseMXRecord to $false and specify the FQDN or IP address of the smart host using the SmartHosts parameter in the same command.

ValidationRecipients

Optional

System.String[]

PARAMVALUE: String[]

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: