For AI agents: the complete documentation index is available at https://docs.ovhcloud.com/en/llms.txt, the full documentation bundle is available at https://docs.ovhcloud.com/en/llms-full.txt, and this page is available as Markdown at https://docs.ovhcloud.com/en/guides/web-cloud/email-and-collaborative-solutions/microsoft-exchange/feature-receive-connector.md.
Skip to content

Exchange - Configure a receive connector

View as Markdown

Place an external anti-spam gateway in front of your OVHcloud Exchange platform with a receive connector, created and managed with the OVHcloud API

Objective

A receive connector tells your Exchange platform which servers are allowed to deliver emails to it, and under which conditions. It lets you place an external anti-spam solution, also called a filtering gateway, in front of your Exchange platform: the MX records of your domain name point to this gateway, which filters incoming emails and then passes them on to Exchange.

The receive connector is available for Private Exchange and Trusted Exchange. It can only be created and managed with the OVHcloud API.

This guide explains how to create, modify, disable and delete a receive connector on your Exchange platform with the OVHcloud API.

Info

To route the outgoing emails of your platform through an external server, use a send connector instead: see our guide "Exchange - Configure a send connector".

Requirements

  • A Private Exchange or Trusted Exchange platform.
  • API credentials created on the , with at least the GET right on /email/exchange and the GET, POST, PUT, PATCH and DELETE rights on /email/exchange/*. Refer to our guide "First Steps with the OVHcloud APIs".
  • The IP addresses of the servers of your external anti-spam solution that will deliver emails to Exchange. Ask the provider of this solution for them.

Instructions

Understanding the default receive connector

Every Exchange platform has a default receive connector. It belongs to Exchange: you can neither modify nor delete it, only enable or disable it. In the API, its default property is true.

As long as it is enabled, your platform accepts all incoming emails, whichever server delivers them: a receive connector you create then has no effect. To make sure only your gateway can deliver emails to Exchange, disable the default connector yourself. It is never disabled automatically, to avoid an abrupt interruption of email reception.

Warning

Disable the default connector last. If no other enabled connector applies, disabling it stops the reception of all emails on the platform. Before you disable it, check that your receive connector is enabled and that the MX records of your domain name point to your gateway.

Finding the path parameters

The receive connector calls need the organisation name (organizationName) and the service name (exchangeService) of your platform. Retrieve them in order: the first call below returns the organisation, which the second one needs.

1. Organisation (organizationName)

List the Exchange organisations of your account with the API call below:

GET/email/exchange

2. Service (exchangeService)

List the Exchange services of the organisation with the API call below:

Creating a receive connector

Create the connector with the API call below:

Fill in the following fields in the request body. Only name, remoteIpRanges and requireTls are required.

FieldTypeDescription
namestringName of the connector, 255 characters at most
remoteIpRangesstring[]IP addresses of the servers allowed to deliver emails through this connector (see below)
requireTlsbooleantrue to require TLS for every email received through this connector
maxMessageSizelongOptional. Maximum size of an email received through this connector, in MB
enabledbooleanOptional. true to enable the connector as soon as it is created (false by default)

Each remoteIpRanges entry can be:

  • a single IP address, for example 203.0.113.10;
  • a network in CIDR notation, for example 203.0.113.0/28;
  • a "start-end" address range, bounds included, for example 203.0.113.10-203.0.113.20.

Both IPv4 and IPv6 addresses are accepted.

Warning

Limits of remoteIpRanges

  • The same IP address cannot be part of two receive connectors of the platform.
  • The whole list, once its entries are joined by commas, must not exceed 255 characters. Prefer a CIDR network to a long list of single addresses.

The call returns a task: the connector is created once this task is complete.

Listing and viewing receive connectors

List the receive connectors of the platform, default connector included, with the API call below:

The call returns the list of connector IDs (id). View the details of a connector with the API call below:

In addition to the creation fields, the response contains id, the ID of the connector, and default, which is true for the default receive connector.

Modifying a receive connector

To modify one or more fields without changing the others, use the API call below:

To replace the whole configuration of the connector, fill in every field in the API call below:

Info

The remoteIpRanges field replaces the stored list as a whole. To add an IP address, send the complete list: the existing addresses and the new one.

To enable or disable a connector, change its enabled field. On the default receive connector, this is the only field you can change: before disabling it, see the "Understanding the default receive connector" section.

Each change returns a task: it takes effect once this task is complete.

Deleting a receive connector

Delete a connector with the API call below:

The call returns a task: the connector is deleted once this task is complete. You cannot delete the default receive connector.

If you delete the last connector other than the default one, the default connector is re-enabled automatically, so as not to block email reception. This depends on the enableDefaultReceiveConnector parameter of the call (true by default): set to false, a disabled default connector stays disabled, and your platform no longer receives any email.

Go further

Exchange - Configure a send connector

Editing an OVHcloud DNS zone

Microsoft Exchange guides

For specialised services (SEO, development, etc.), contact OVHcloud partners.

If you would like assistance using and configuring your OVHcloud solutions, please refer to our support offers.

Join our community of users.

Was this page helpful?