Commands › Exchange Online
Set-ReceiveConnector
Modify Receive connectors on Mailbox servers and Edge Transport servers.
Quick start script
# Set-ReceiveConnector — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org
# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-ReceiveConnector
$before | Format-List
# 3. Make the change (dry run first)
Set-ReceiveConnector -Identity <ReceiveConnectorIdParameter> -WhatIf
Set-ReceiveConnector -Identity <ReceiveConnectorIdParameter>
# 4. Verify and diff
$after = Get-ReceiveConnector
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
Set-ReceiveConnector [-Identity] <ReceiveConnectorIdParameter>
[-AdvertiseClientSettings <Boolean>]
[-AuthMechanism <AuthMechanisms>]
[-AuthTarpitInterval <EnhancedTimeSpan>]
[-Banner <String>]
[-BareLinefeedRejectionEnabled <Boolean>]
[-BinaryMimeEnabled <Boolean>]
[-Bindings <MultiValuedProperty>]
[-ChunkingEnabled <Boolean>]
[-Comment <String>]
[-Confirm]
[-ConnectionInactivityTimeout <EnhancedTimeSpan>]
[-ConnectionTimeout <EnhancedTimeSpan>]
[-DefaultDomain <AcceptedDomainIdParameter>]
[-DeliveryStatusNotificationEnabled <Boolean>]
[-DomainController <Fqdn>]
[-DomainSecureEnabled <Boolean>]
[-EightBitMimeEnabled <Boolean>]
[-EnableAuthGSSAPI <Boolean>]
[-Enabled <Boolean>]
[-EnhancedStatusCodesEnabled <Boolean>]
[-ExtendedProtectionPolicy <ExtendedProtectionPolicySetting>]
[-Fqdn <Fqdn>]
[-LongAddressesEnabled <Boolean>]
[-MaxAcknowledgementDelay <EnhancedTimeSpan>]
[-MaxHeaderSize <ByteQuantifiedSize>]
[-MaxHopCount <Int32>]
[-MaxInboundConnection <Unlimited>]
[-MaxInboundConnectionPerSource <Unlimited>]
[-MaxInboundConnectionPercentagePerSource <Int32>]
[-MaxLocalHopCount <Int32>]
[-MaxLogonFailures <Int32>]
[-MaxMessageSize <ByteQuantifiedSize>]
[-MaxProtocolErrors <Unlimited>]
[-MaxRecipientsPerMessage <Int32>]
[-MessageRateLimit <Unlimited>]
[-MessageRateSource <MessageRateSourceFlags>]
[-Name <String>]
[-OrarEnabled <Boolean>]
[-PermissionGroups <PermissionGroups>]
[-PipeliningEnabled <Boolean>]
[-ProtocolLoggingLevel <ProtocolLoggingLevel>]
[-RejectReservedSecondLevelRecipientDomains <Boolean>]
[-RejectReservedTopLevelRecipientDomains <Boolean>]
[-RejectSingleLabelRecipientDomains <Boolean>]
[-RemoteIPRanges <MultiValuedProperty>]
[-RequireEHLODomain <Boolean>]
[-RequireTLS <Boolean>]
[-ServiceDiscoveryFqdn <Fqdn>]
[-SizeEnabled <SizeMode>]
[-SmtpUtf8Enabled <Boolean>]
[-SuppressXAnonymousTls <Boolean>]
[-TarpitInterval <EnhancedTimeSpan>]
[-TlsCertificateName <SmtpX509Identifier>]
[-TlsDomainCapabilities <MultiValuedProperty>]
[-TransportRole <ServerRole>]
[-WhatIf]
[<CommonParameters>]Parameters (57)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Identity | ReceiveConnectorIdParameter | yes | The Identity parameter specifies the Receive connector that you want to modify. You can use any value that uniquely identifies the Receive connector. For example: |
| -AdvertiseClientSettings | Boolean | The AdvertiseClientSettings parameter specifies whether the SMTP server name, port number, and authentication settings for the Receive connector are displayed to users in the options of Outlook on the web. Valid values are: | |
| -AuthMechanism | AuthMechanisms | The AuthMechanism parameter specifies the advertised and accepted authentication mechanisms for the Receive connector. Valid values are: | |
| -AuthTarpitInterval | EnhancedTimeSpan | The AuthTarpitInterval parameter specifies the period of time to delay responses to failed authentication attempts from remote servers that might be abusing the connection. The default value is 5 seconds. | |
| -Banner | String | The Banner parameter specifies a custom SMTP 220 banner that's displayed to remote messaging servers that connect to the Receive connector. When you specify a value, enclose the value in quotation marks, and start... | |
| -BareLinefeedRejectionEnabled | Boolean | The BareLinefeedRejectionEnabled parameter specifies whether this Receive connector rejects messages that contain line feed (LF) characters without immediately preceding carriage return characters (CR) in the SMTP... | |
| -BinaryMimeEnabled | Boolean | The BinaryMimeEnabled parameter specifies whether the BINARYMIME Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: | |
| -Bindings | MultiValuedProperty | The Bindings parameter specifies the local IP address and TCP port number that's used by the Receive connector. This parameter uses the syntax `"IPv4Address:TCPPort","IPv6Address:TCPPort"`. You can specify an IPv4... | |
| -ChunkingEnabled | Boolean | The ChunkingEnabled parameter specifies whether the CHUNKING Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: | |
| -Comment | 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 | SwitchParameter | The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. | |
| -ConnectionInactivityTimeout | EnhancedTimeSpan | The ConnectionInactivityTimeout parameter specifies the maximum amount of idle time before a connection to the Receive connector is closed. | |
| -ConnectionTimeout | EnhancedTimeSpan | The ConnectionTimeout parameter specifies the maximum time that the connection to the Receive connector can remain open, even if the connection is actively transmitting data. | |
| -DefaultDomain | AcceptedDomainIdParameter | The DefaultDomain parameter specifies the default accepted domain to use for the Exchange organization. You can use any value that uniquely identifies the accepted domain. For example: | |
| -DeliveryStatusNotificationEnabled | Boolean | The DeliveryStatusNotificationEnabled parameter specifies whether the DSN (delivery status notification) Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: | |
| -DomainController | Fqdn | The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name... | |
| -DomainSecureEnabled | Boolean | The DomainSecureEnabled parameter specifies whether to enable or disable mutual Transport Layer Security (TLS) authentication (also known as Domain Secure) for the domains that are serviced by the Receive connector.... | |
| -EightBitMimeEnabled | Boolean | The EightBitMimeEnabled parameter specifies whether the 8BITMIME Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: | |
| -EnableAuthGSSAPI | Boolean | The EnableAuthGSSAPI parameter enables or disables Kerberos when Integrated Windows authentication is available on the Receive connector (the AuthMechanism parameter contains the value Integrated). Valid values are: | |
| -Enabled | Boolean | The Enabled parameter specifies whether to enable or disable the Receive connector. Valid values are: | |
| -EnhancedStatusCodesEnabled | Boolean | The EnhancedStatusCodesEnabled parameter specifies whether the ENHANCEDSTATUSCODES Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: | |
| -ExtendedProtectionPolicy | ExtendedProtectionPolicySetting | The ExtendedProtectionPolicy parameter specifies how you want to use Extended Protection for Authentication on the Receive connector.Valid values are: | |
| -Fqdn | Fqdn | The Fqdn parameter specifies the destination FQDN that's shown to connected messaging servers. This value is used in the following locations: | |
| -LongAddressesEnabled | 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... | |
| -MaxAcknowledgementDelay | EnhancedTimeSpan | This parameter isn't used by Exchange Server 2016. It's used only by Exchange 2010 servers in coexistence environments. | |
| -MaxHeaderSize | ByteQuantifiedSize | The MaxHeaderSize parameter specifies the maximum size of the SMTP message header before the Receive connector closes the connection. The default value is 256 kilobytes (262144 bytes). | |
| -MaxHopCount | 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 Received... | |
| -MaxInboundConnection | Unlimited | The MaxInboundConnection parameter specifies the maximum number of inbound connections that this Receive connector serves at the same time. | |
| -MaxInboundConnectionPercentagePerSource | 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... | |
| -MaxInboundConnectionPerSource | Unlimited | The MaxInboundConnectionPerSource parameter specifies the maximum number of connections that this Receive connector serves at the same time from a single IP address. | |
| -MaxLocalHopCount | 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... | |
| -MaxLogonFailures | Int32 | The MaxLogonFailures parameter specifies the number of logon failures that the Receive connector retries before it closes the connection. | |
| -MaxMessageSize | ByteQuantifiedSize | The MaxMessageSize parameter specifies the maximum size of a message that's allowed through the Receive connector. The default value is 36 MB, which results in a realistic maximum message size of 25 MB. | |
| -MaxProtocolErrors | Unlimited | The MaxProtocolErrors parameter specifies the maximum number of SMTP protocol errors that the Receive connector accepts before closing the connection. | |
| -MaxRecipientsPerMessage | Int32 | The MaxRecipientsPerMessage parameter specifies the maximum number of recipients per message that the Receive connector accepts before closing the connection. | |
| -MessageRateLimit | Unlimited | The MessageRateLimit parameter specifies the maximum number of messages that can be sent by a single client IP address per minute. | |
| -MessageRateSource | MessageRateSourceFlags | The MessageRateSource parameter specifies how the message submission rate is calculated. Valid values are: | |
| -Name | String | The Name parameter specifies the unique name for the Receive connector. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks. | |
| -OrarEnabled | Boolean | The OrarEnabled parameter enables or disables Originator Requested Alternate Recipient (ORAR) on the Receive connector. Valid values are: | |
| -PermissionGroups | PermissionGroups | The PermissionGroups parameter specifies the well-known security principals who are authorized to use the Receive connector and the permissions that are assigned to them. Valid values are: | |
| -PipeliningEnabled | Boolean | The PipeliningEnabled parameter specifies whether the PIPELINING Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: | |
| -ProtocolLoggingLevel | ProtocolLoggingLevel | The ProtocolLoggingLevel parameter specifies whether to enable or disable protocol logging for the Receive connector. Valid values are: | |
| -RejectReservedSecondLevelRecipientDomains | Boolean | The RejectReservedSecondLevelRecipientDomains parameter specifies whether to reject connections that contain recipients in reserved second-level domains as specified in RFC 2606 (example.com, example.net, or... | |
| -RejectReservedTopLevelRecipientDomains | Boolean | The RejectReservedTopLevelRecipientDomains parameter specifies whether to reject connections that contain recipients in reserved top-level domains (TLDs) as specified in RFC 2606 (.test, .example, .invalid, or... | |
| -RejectSingleLabelRecipientDomains | Boolean | The RejectSingleLabelRecipientDomains parameter specifies whether to reject connections that contain recipients in single-label domains (for example, chris@contoso instead of chris@contoso.com). Valid values are: | |
| -RemoteIPRanges | MultiValuedProperty | The RemoteIPRanges parameter specifies the remote IP addresses that the Receive connector accepts messages from. Valid values are: | |
| -RequireEHLODomain | Boolean | The RequireEHLODomain parameter specifies whether the client must provide a domain name in the EHLO handshake after the SMTP connection is established. Valid values are: | |
| -RequireTLS | Boolean | The RequireTLS parameter specifies whether to require TLS transmission for inbound messages on the Receive connector. Valid values are: | |
| -ServiceDiscoveryFqdn | Fqdn | The ServiceDiscoveryFqdn parameter specifies the service discovery fully-qualified domain name (FQDN). for the Receive connector. | |
| -SizeEnabled | SizeMode | The SizeEnabled parameter specifies how the SIZE Extended SMTP extension is used on the Receive connector. Valid values are: | |
| -SmtpUtf8Enabled | Boolean | This parameter is reserved for internal Microsoft use. | |
| -SuppressXAnonymousTls | Boolean | The SuppressXAnonymousTls parameter specifies whether the X-ANONYMOUSTLS Extended SMTP extension is enabled or disabled on the Receive connector. Valid values are: | |
| -TarpitInterval | EnhancedTimeSpan | The TarpitInterval parameter specifies the period of time to delay an SMTP response to a remote server that might be abusing the connection. The default value is 00:00:05 (5 seconds). | |
| -TlsCertificateName | SmtpX509Identifier | The TlsCertificateName parameter specifies the X.509 certificate to use for TLS encryption. A valid value for this parameter is `"<I>X.500Issuer<S>X.500Subject"`. The X.500Issuer value is found in the certificate's... | |
| -TlsDomainCapabilities | MultiValuedProperty | The TlsDomainCapabilities parameter specifies the capabilities that the Receive connector makes available to specific hosts outside of the organization. Remote hosts are authenticated with TLS with certificate... | |
| -TransportRole | ServerRole | The TransportRole parameter specifies the transport service on the Mailbox server where the Receive connector is created. Valid values are: | |
| -WhatIf | SwitchParameter | The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch. |
Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.