API

Eine Domain abrufen

Ergänzt die Adressen, die es auf ihr gibt, und ob die jeweilige aktiviert ist.

GETapi.openemail.uk/domains/{id}

Führt den echten Aufruf gegen Ihren Workspace aus, mit Ihrem eigenen Schlüssel.

GET /domains/{id}

Ergänzt die Adressen, die es auf ihr gibt, und ob die jeweilige aktiviert ist.

Beispiel

Erfordert domains:read.

curl

curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f" -H "$AUTH"

Antwort

{  "object": "domain",  "id": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f",  "domain": "acme.com",  "receiving": {    "verified": true,    "verifiedAt": "2026-08-14T10:02:00.000Z",    "catchAll": false,    "lastCheckedAt": "2026-08-29T06:00:00.000Z",    "error": null  },  "sending": {    "status": "verified",    "canSend": true,    "checkedAt": "2026-08-29T06:00:00.000Z",    "error": null,    "note": "Mail from this domain is signed and can be sent."  },  "tracking": {    "host": "links.acme.com",    "status": "active",    "active": true,    "target": "oelinks3f9a1c7e2b8d4a60.edge.openemail.uk",    "record": { "type": "CNAME", "name": "links.acme.com", "value": "oelinks3f9a1c7e2b8d4a60.edge.openemail.uk" },    "checkedAt": "2026-08-29T06:10:00.000Z",    "verifiedAt": "2026-08-29T06:10:00.000Z",    "error": null  },  "storage": {    "host": "files.acme.com",    "status": "active",    "active": true,    "target": "oefiles81c40d6b2f7e9a35.edge.openemail.uk",    "record": { "type": "CNAME", "name": "files.acme.com", "value": "oefiles81c40d6b2f7e9a35.edge.openemail.uk" },    "checkedAt": "2026-08-29T06:10:00.000Z",    "verifiedAt": "2026-08-29T06:10:00.000Z",    "error": null  },  "addresses": [    { "address": "[email protected]", "enabled": true },    { "address": "[email protected]", "enabled": false }  ],  "createdAt": "2026-08-14T09:55:11.000Z"}

Eine deaktivierte Adresse ist nicht mehr zustellbar. Mail an sie wird bereits zur SMTP-Zeit abgelehnt, der Absender erhält also einen Bounce statt Schweigen.

Was hier noch nicht möglich ist

Noch nicht verfügbar

Die Schreibzugriffe, die diese Ressource annimmt, sind die eigene Tracking-Domain und die eigene Dateien-Domain, beide über PATCH /domains/{id}. Der Rest der Einrichtung einer Domain ist vorerst nur in der App möglich.

Eine Domain hinzufügen und die zu veröffentlichenden DNS-Einträge lesen. GET meldet, dass eine Domain unverifiziert ist, aber nicht, welcher Eintrag fehlt.
Eine erneute Prüfung von receiving oder sending auslösen. Für beides gibt es keinen Endpunkt, und beides braucht auch keinen: Ein stündlicher Durchlauf prüft jede unverifizierte Domain von selbst erneut; die Einträge zu veröffentlichen und stehen zu lassen ist die ganze Arbeit. Abonnieren Sie domain.verified und domain.sending_changed, statt GET /domains abzufragen, dann erfahren Sie es in dem Moment, in dem sich eines von beiden bewegt. PATCH /domains/{id} prüft nur die Tracking-Domain und die Dateien-Domain.
Eine Adresse anlegen, deaktivieren oder weiterleiten. Das TEILEN ist umgesetzt, denn POST /members/{userId}/addresses übergibt eine bestehende Adresse an jemanden auf member- oder viewer-Ebene. Was diese Ressource nicht kann, ist, die Adresse überhaupt erst entstehen zu lassen.

All das gibt es in der App unter Einstellungen → Domains. Es fehlt die API-Oberfläche, nicht die Funktion.