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 Anfrage an den POST/v2/projects/{projectId}/mail-addresses/-Endpunkt. Die Anfrage muss ein JSON-Objekt mit den folgenden Eigenschaften enthalten:

  • addressstring (idn-email)
    required
  • isCatchAllboolean
    required
  • mailboxobject
    required
    • enableSpamProtectionboolean
      required
    • passwordstring
      required
    • quotaInBytesnumber (≥ -1)
      required

      2 GB

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 Anfrage an den POST/v2/projects/{projectId}/mail-addresses/-Endpunkt. Die Anfrage muss ein JSON-Objekt mit den folgenden Eigenschaften enthalten:

  • addressstring (idn-email)
    required
  • forwardAddressesarray of string (idn-email)
    required
    • Array[
    • *string (idn-email)
      • ]

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 Anfrage an den POST/v2/projects/{projectId}/delivery-boxes/-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.

E-Mail-Konten löschen​

Um eine E-Mail-Adresse oder Postausgang zu löschen, sende eine Anfrage an den DELETE/v2/mail-addresses/{mailAddressId}/- oder DELETE/v2/delivery-boxes/{deliveryBoxId}/-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.