Zum Hauptinhalt springen

E-Mail-Konten über die API verwalten

Arten von E-Mail-Konten​

In unserer API unterscheiden wir zwischen zwei Arten von E-Mail-Konten:

  • E-Mail-Adressen werden verwendet, um E-Mails zu senden und zu empfangen. Sie sind entweder mit einem Postfach (das du mit einem E-Mail-Client verbinden kannst) oder mit einer Weiterleitungsadresse (die alle eingehenden E-Mails an eine oder mehrere andere E-Mail-Adressen weiterleitet) verknüpft.
  • Postausgänge werden verwendet, um E-Mails zu senden. Sie werden verwendet, um E-Mails von einer Webanwendung oder einem Skript zu senden.

Voraussetzungen​

Um E-Mail-Konten zu verwalten, benötigst du ein bestehendes Projekt. Um ein neues Projekt per API zu erstellen, folge dem "Erstellen eines Projekts"-Guide.

Ein neues E-Mail-Konto erstellen​

Um ein neues E-Mail-Konto zu erstellen, sende eine POST-Anfrage an den /v2/projects/{projectID}/mailaddresses-Endpunkt. Die Anfrage muss ein JSON-Objekt mit den folgenden Eigenschaften enthalten:

address
required
string <idn-email>
isCatchAll
required
boolean
required
object
{
  • "address": "пошта@укр.нет",
  • "isCatchAll": true,
  • "mailbox": {
    }
}
caution

Merke dir das Passwort, das du für das E-Mail-Konto festgelegt hast. Du hast später keine Möglichkeit mehr, es über die API abzurufen.

info
Für Details siehe auch die Endpoint-Dokumentation für den folgenden API-Endpoint: mail-mailaddress-create

Eine neue Weiterleitungsadresse erstellen​

Eine Weiterleitungsadresse ist eine E-Mail-Adresse, die alle eingehenden E-Mails an eine oder mehrere andere E-Mail-Adressen weiterleitet. Um eine neue Weiterleitungsadresse zu erstellen, sende eine POST-Anfrage an den /v2/projects/{projectID}/mailaddresses-Endpunkt. Die Anfrage muss ein JSON-Objekt mit den folgenden Eigenschaften enthalten:

address
required
string <idn-email>
forwardAddresses
required
Array of strings <idn-email> [ items <idn-email > ]
{
  • "address": "пошта@укр.нет",
  • "forwardAddresses": [
    ]
}

Einen neuen Postausgang erstellen​

Ein Postausgang ist eine E-Mail-Adresse, die verwendet wird, um E-Mails von einer Webanwendung oder einem Skript zu senden. Um einen neuen Postausgang zu erstellen, sende eine POST-Anfrage an den /v2/projects/{projectID}/deliveryboxes-Endpunkt. Die Anfrage muss ein JSON-Objekt mit den folgenden Eigenschaften enthalten:

  • description (String, Pflichtfeld): Eine Beschreibung des Postausgangs. Diese Beschreibung wird in der Web-Oberfläche angezeigt.
  • password (String, Pflichtfeld): Das Passwort für den Postausgang. Dieses Passwort wird verwendet, um sich gegenüber dem SMTP-Server zu authentifizieren.
caution

Merke dir das Passwort, das du für das E-Mail-Konto festgelegt hast. Du hast später keine Möglichkeit mehr, es über die API abzurufen.

info
Für Details siehe auch die Endpoint-Dokumentation für den folgenden API-Endpoint: mail-deliverybox-create

E-Mail-Konten löschen​

Um eine E-Mail-Adresse oder Postausgang zu löschen, sende eine DELETE-Anfrage an den /v2/mailaddresses/{id} oder /v2/deliveryboxes/{id}-Endpunkt (je nachdem, welches Konto du löschen möchtest). Der id-Parameter muss die ID der E-Mail-Adresse oder des Postausgangs enthalten, den du löschen möchtest. Es ist kein Request-Body erforderlich.