Skip to content

SK-1714-WEB-Email-Exchange-send_connector-API_update #8467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
+404 −141
Open

SK-1714-WEB-Email-Exchange-send_connector-API_update #8467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0fb16c9
update_FR
BrenKt Oct 1, 2025
7e3522c
FR proof & minor update on one link (ES-FR-IT-PL-PT)
benchbzh Oct 2, 2025
a6f3c88
translations
BrenKt Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 51 additions & 15 deletions ...ollaborative_solutions/microsoft_exchange/feature_send_connector/guide.de-de.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Einen Send Connector auf Ihrer Private Exchange oder Trusted Exchange Plattform konfigurieren
excerpt: Erfahren Sie hier, wie Sie einen SMTP Send Connector auf Ihrer OVHcloud Exchange Plattform hinzufügen
updated: 2023-11-06
updated: 2025-10-07
---

<style>
Expand Down Expand Up @@ -44,7 +44,6 @@ Hier der Kontext des obigen Diagramms:
- **[email protected]** sendet eine E-Mail an **[email protected]**: Dies ist ein Standard-Versand, da der Send Connector nicht an **[email protected]** angehängt wurde. **[email protected]** erhält also die E-Mail vom Sendeserver der Exchange Plattform (*Outgoing Mail Server*).
- **[email protected]** sendet eine E-Mail an **[email protected]** : **[email protected]** wurde an den Send Connector angehängt, **[email protected]** erhält die E-Mail vom Sendeserver des auf der Exchange Plattform eingerichteten (*Send Connectors*).


## Voraussetzungen

- Sie haben eine OVHcloud [Private Exchange Plattform](/links/web/emails-private-exchange) oder [Trusted Exchange Plattform](/links/web/emails-trusted-exchange) abonniert.
Expand All @@ -71,7 +70,6 @@ Sie finden außerdem nützliche Hinweise für die folgenden Operationen.
> [!warning]
>
> Das Hinzufügen eines Send Connectors ist reserviert für die Dienste [OVHcloud Private Exchange](/links/web/emails-private-exchange) und [OVHcloud Trusted Exchange](/links/web/emails-trusted-exchange). Wenn Sie einen Send Connector für ein anderes OVHcloud Exchange-Angebot aktivieren, kann die Funktion aus Sicherheitsgründen jederzeit von unseren Administratoren deaktiviert werden.
>

Bevor Sie beginnen, halten Sie folgende Informationen bereit. Sie erhalten sie vom Anbieter, der den Send Connector bereitstellt.

Expand All @@ -88,8 +86,13 @@ Verwenden Sie den folgenden API-Aufruf, um Ihrer Exchange Plattform einen Send C
>
> @api {v1} /email/exchange POST /email/exchange/{organizationName}/service/{exchangeService}/sendConnector

- `organizationName`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.
In de sectie **PATH PARAMETERS**:

- `exchangeService`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.
- `organizationName`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.

Op het tabblad **EXAMPLE** in het gedeelte **REQUEST BODY** kunt u de velden invullen met uw waarden:

- `displayName`: Anzeigename des Send Connectors.
- `maxSendSize`: Maximale Größe einer E-Mail beim Versand in MB (maximal 100 MB und der Standard wenn Sie nichts eingeben).
- `password`: Kennwort, das an den Benutzer des Send Connectors angefügt ist.
Expand All @@ -99,6 +102,12 @@ Verwenden Sie den folgenden API-Aufruf, um Ihrer Exchange Plattform einen Send C
- `smartHostAuthMechanism`: Der für den Send Connector verwendete Authentifizierungsmechanismus.
- `user`: Der Benutzer, der dem Send Connector zugeordnet ist.

> [!primary]
>
> De knop `Only required fields` onder het invoervak geeft alleen de verplichte velden weer.

Klik op `Execute`{.action} om de API-call te starten.

Diese Art von Ergebnis wird angezeigt:

``` console
Expand All @@ -117,8 +126,12 @@ Nachdem der Send Connector erstellt wurde, rufen Sie die ID des Send Connectors
>
> @api {v1} /email/exchange GET email/exchange/{organizationName}/service/{exchangeService}/sendConnector

- `organizationName`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.
In de sectie **PATH PARAMETERS**:

- `exchangeService`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.
- `organizationName`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.

Klik op `Execute`{.action} om de API-call te starten.

Diese Art von Ergebnis wird angezeigt:

Expand All @@ -134,9 +147,13 @@ Sie finden die Details Ihres Send Connectors über diesen Aufruf: <a name="idcon
>
> @api {v1} /email/exchange GET /email/exchange/{organizationName}/service/{exchangeService}/sendConnector/{id}

- `organizationName`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.
- `id`: Geben Sie die ID Ihres Send Connectors ein, die Sie im vorherigen Schritt erhalten haben.
In de sectie **PATH PARAMETERS**:

- `exchangeService`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.
- `id`: Geben Sie die ID Ihres Send Connectors ein, die Sie im vorherigen Schritt erhalten haben.
- `organizationName`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.

Klik op `Execute`{.action} om de API-call te starten.

Diese Art von Ergebnis wird angezeigt:

Expand Down Expand Up @@ -166,12 +183,18 @@ Verwenden Sie den API-Aufruf zur Einrichtung eines Exchange Accounts, um die ID
>
> @api {v1} /email/exchange PUT /email/exchange/{organizationName}/service/{exchangeService}/account/{primaryEmailAddress}

In de sectie **PATH PARAMETERS**:

- `organizationName`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.
- `primaryEmailAddress`: Geben Sie eine der E-Mail-Adressen Ihrer Exchange Plattform ein, an die Sie den Send Connector anhängen möchten.
- `exchangeService`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.
- `Account`: Hier werden die Informationen zur E-Mail-Adresse eingegeben. **Beachten Sie nur die Zeile zum Send Connector**.
- `sendConnectorId`: Geben Sie die ID des Send Connectors ein, die im vorherigen Schritt [ermittelt wurde](#idconnector).
- Aktivieren Sie `deleteVirus` (falls nicht bereits aktiviert), um beim Ausführen des API-Aufrufs keine Fehler zu erhalten.

Op het tabblad **EXAMPLE** in het gedeelte **REQUEST BODY** kunt u de waarden voor de twee onderstaande velden wijzigen:

- `sendConnectorId`: Geben Sie „0“ ein, um die Sendeserver-ID der Exchange Plattform festzulegen.
- `deleteVirus`: Geben Sie "true" statt "false" ein, um bei der Ausführung des API-Aufrufs keine Fehler zu erhalten.

Klik op `Execute`{.action} om de API-call te starten.

Sie erhalten folgendes Ergebnis:

Expand Down Expand Up @@ -247,12 +270,18 @@ Um einen Send Connector zu entfernen, verwenden Sie den API-Aufruf zum Einrichte
>
> @api {v1} /email/exchange PUT /email/exchange/{organizationName}/service/{exchangeService}/account/{primaryEmailAddress}

In de sectie **PATH PARAMETERS**:

- `exchangeService`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.
- `organizationName`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.
- `primaryEmailAddress`: Geben Sie eine der E-Mail-Adressen Ihrer Exchange Plattform ein, von der Sie den Send Connector trennen möchten.
- `exchangeService`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.
- `Account`: Tragen Sie hier die Informationen zur im Feld „primaryEmailAddress“ eingegebenen E-Mail-Adresse ein. Beachten Sie nur die Zeile zum Send Connector.
- `sendConnectorId`: Geben Sie „0“ ein, um die Sendeserver-ID der Exchange Plattform festzulegen.
- Aktivieren Sie `deleteVirus` (falls nicht bereits aktiviert), um beim Ausführen des API-Aufrufs keine Fehler zu erhalten.

Ändern Sie auf der Registerkarte **EXAMPLE** im Abschnitt **REQUEST BODY** die Werte in den beiden folgenden Feldern:

- `sendConnectorId`: Geben Sie „0“ ein, um die Sendeserver-ID der Exchange Plattform festzulegen.
- `deleteVirus`: Geben Sie "true" statt "false" ein, um bei der Ausführung des API-Aufrufs keine Fehler zu erhalten.

Klik op `Execute`{.action} om de API-call te starten.

Sie erhalten folgendes Ergebnis:

Expand All @@ -272,12 +301,19 @@ Verwenden Sie hierzu folgenden API-Aufruf:
>
> @api {v1} /email/exchange PUT /email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/changeDefaultSBR

In de sectie **PATH PARAMETERS**:

- `organizationName`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.
- `exchangeService`: Geben Sie den Namen Ihrer Exchange Plattform in der Form „private-zz111111-1“ oder „dedicated-zz11111-1“ ein.
- `domainName`: Geben Sie den Domainnamen ein, der den Send Connector nutzen soll.

Füllen Sie auf dem Tab **EXAMPLE** im Abschnitt **REQUEST BODY** die Felder mit Ihren Werten aus:

- `sbrDefault `: Lassen Sie das Feld leer.
- `sendConnectorIdDefault`: Geben Sie die ID des Send Connectors ein, die in [diesem Schritt](#idconnector) ermittelt wurde.

Klik op `Execute`{.action} om de API-call te starten.

Sie erhalten folgendes Ergebnis:

``` console
Expand Down Expand Up @@ -332,4 +368,4 @@ Kontaktieren Sie für spezialisierte Dienstleistungen (SEO, Web-Entwicklung etc.

Wenn Sie Hilfe bei der Nutzung und Konfiguration Ihrer OVHcloud Lösungen benötigen, beachten Sie unsere [Support-Angebote](/links/support).

Treten Sie unserer [User Community](/links/community) bei.
Treten Sie unserer [User Community](/links/community) bei.
74 changes: 56 additions & 18 deletions ...ollaborative_solutions/microsoft_exchange/feature_send_connector/guide.en-gb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Configure a send connector on your Private or Trusted Exchange platform
excerpt: Find out how to add an SMTP send connector to your OVHcloud Exchange platform
updated: 2023-11-06
updated: 2025-10-07
---

<style>
Expand Down Expand Up @@ -86,8 +86,13 @@ To add a send connector to your Exchange platform, use the following API call.
>
> @api {v1} /email/exchange POST /email/exchange/{organizationName}/service/{exchangeService}/sendConnector

- `organizationName`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
In the section **PATH PARAMETERS**:

- `exchangeService`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
- `organizationName`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".

In the **EXAMPLE** tab in the **REQUEST BODY** section, fill in the fields with your values:

- `displayName`: The display name of your send connector.
- `maxSendSize`: Maximum size in MB of an email when sending (100MB maximum and default if left empty).
- `password`: The password attached to the send connector user.
Expand All @@ -97,6 +102,12 @@ To add a send connector to your Exchange platform, use the following API call.
- `smartHostAuthMechanism`: Authentication mechanism used for send connector.
- `user`: The user associated with the send connector.

> [!primary]
>
> The `Only required fields` button below the input box displays only the required fields.

Click `Execute`{.action} to launch the API call.

You get this type of result:

``` console
Expand All @@ -115,8 +126,12 @@ Once the send connector has been created, use the following API call to retrieve
>
> @api {v1} /email/exchange GET email/exchange/{organizationName}/service/{exchangeService}/sendConnector

In the section **PATH PARAMETERS**:

- `exchangeService`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
- `organizationName` : Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
- `ExchangeService`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".

Click `Execute`{.action} to launch the API call.

You get this type of result:

Expand All @@ -132,9 +147,13 @@ You can find the details of your send connector using this API call: <a name="id
>
> @api {v1} /email/exchange GET /email/exchange/{organizationName}/service/{exchangeService}/sendConnector/{id}

- `organizationName`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
In the section **PATH PARAMETERS**:

- `exchangeService`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
- `id`: Enter the ID of your send connector, obtained as a number in the previous step.
- `ExchangeService`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
- `organizationName`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".

Click `Execute`{.action} to launch the API call.

You get this type of result:

Expand Down Expand Up @@ -164,12 +183,18 @@ Use the Exchange account setup API call to add your send connector ID to an emai
>
> @api {v1} /email/exchange PUT /email/exchange/{organizationName}/service/{exchangeService}/account/{primaryEmailAddress}

In the section **PATH PARAMETERS**:

- `exchangeService`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
- `organizationName` : Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
- `primaryEmailAddress`: Enter one of the email addresses of your Exchange platform, to which you want to attach the send connector.
- `ExchangeService`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
- `Account`: This is where the information linked to the email address is entered. **We will only look at the line related to the send connector**.
- `sendConnectorId`: Enter the ID of your send connector, obtained as a number in [the previous](#idconnector) step.
- Tick the `deleteVirus` box (if it is not already ticked) to not get an error when executing the API call.

In the **EXAMPLE** tab in the **REQUEST BODY** section, modify the values in the two fields below:

- `sendConnectorId`: Enter the ID of your send connector, obtained as a number in [the previous](#idconnector) step.
- `deleteVirus`: Enter “true” instead of “false” to avoid getting an error when executing the API call.

Click `Execute`{.action} to launch the API call.

The result is as follows:

Expand Down Expand Up @@ -245,12 +270,18 @@ To remove a send connector attached to an account from the Exchange platform, us
>
> @api {v1} /email/exchange PUT /email/exchange/{organizationName}/service/{exchangeService}/account/{primaryEmailAddress}

- `organizationName` : enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
- `primaryEmailAddress`: Enter one of the email addresses of your Exchange platform, to which you want to detach the send connector.
- `ExchangeService`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
- `Account`: Enter the information linked to the email address entered in the “primaryEmailAddress” box. We will only look at the lines related to the send connector.
- `sendConnectorId`: Type '0' to set the Send Server ID of the Exchange platform.
- Check the `deleteVirus` box (if it is not already ticked) to avoid getting an error.
In the section **PATH PARAMETERS**:

- `exchangeService`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
- `organizationName` : Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
- `primaryEmailAddress`: Enter one of the email addresses of your Exchange platform, to which you want to attach the send connector.

In the **EXAMPLE** tab in the **REQUEST BODY** section, modify the values in the two fields below:

- `sendConnectorId`: Enter the ID of your send connector, obtained as a number in [the previous](#idconnector) step.
- `deleteVirus`: Enter “true” instead of “false” to avoid getting an error when executing the API call.

Click `Execute`{.action} to launch the API call.

The result is as follows:

Expand All @@ -270,12 +301,19 @@ To do this, use the following API call:
>
> @api {v1} /email/exchange PUT /email/exchange/{organizationName}/service/{exchangeService}/domain/{domainName}/changeDefaultSBR

- `organizationName`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
- `ExchangeService`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
In the section **PATH PARAMETERS**:

- `domainName`: Enter the domain name that will benefit from the send connector.
- `exchangeService`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".
- `organizationName`: Enter the name of your Exchange platform, which is in the form of "private-zz11111-1" or "dedicated-zz111111-1".

In the **EXAMPLE** tab in the **REQUEST BODY** section, modify the values in the two fields below:

- `sbrDefault `: Leave empty.
- `sendConnectorIdDefault`: Enter the ID of your send connector, obtained as a number in [this step](#idconnector).

Click `Execute`{.action} to launch the API call.

The result is as follows:

``` console
Expand Down Expand Up @@ -330,4 +368,4 @@ 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](/links/support).

Join our [community of users](/links/community).
Join our [community of users](/links/community).
Loading