API

Llistar dominis

Tots els dominis de l'espai de treball, amb el seu estat de recepció, enviament, seguiment i fitxers.

GETapi.openemail.uk/domains

Executa la crida real contra el teu espai de treball, amb la teva pròpia clau.

GET /domains

Tots els dominis de l'espai de treball, amb el seu estat de recepció, enviament, seguiment i fitxers.

La recepció i l'enviament són coses separades

Cada domini informa de la recepció i l'enviament com dos objectes d'estat independents. receiving.verified vol dir que l'MX del domini porta el seu correu aquí i que el seu repte de propietat està publicat, de manera que el domini pot rebre lliuraments. No diu res sobre la sortida.

sending és la meitat de sortida, llegida de la comprovació de signatura desada del domini i no d'una de nova. sending.status és un de verified, pending, failed, no_identity o unknown, sending.canSend diu si ara mateix s'acceptaria un enviament des del domini, sending.checkedAt data aquest veredicte, sending.error porta l'últim error i sending.note és una frase que explica l'estat. Un veredicte negatiu de fa més d'un dia es tracta com a desconegut i no com un rebuig, de manera que canSend pot ser cert mentre status és pending.

tracking és un tercer objecte, sobre el domini de seguiment personalitzat opcional del domini i no sobre el seu correu. tracking.status és none fins que se'n configura un, a l'aplicació o amb PATCH /domains/{id}, la pàgina del qual descriu cada camp.

storage és un quart objecte amb els mateixos camps, sobre el domini de fitxers personalitzat opcional del domini: el nom que fan servir els enllaços de descàrrega dels fitxers enviats des del domini. Es configura de la mateixa manera i a la mateixa pàgina, i storage.status és none fins que se'n configura un.

Exemple

Requereix domains:read.

curl

curl "$OE/domains" -H "$AUTH"

Resposta

{  "object": "list",  "data": [    {      "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      },      "createdAt": "2026-08-14T09:55:11.000Z"    }  ]}

lastCheckedAt a null vol dir que no s'ha mirat mai el DNS: "encara no hem mirat", no "ha fallat". Les dues coses es llegeixen molt diferent trenta segons després d'afegir un domini.