Ugrás a dokumentációra
API

Domainek listázása

A munkaterület minden domainje, a fogadási, küldési, követési és fájlállapotával együtt.

GETapi.openemail.uk/domains

A valódi hívást futtatja le a munkaterületén, a saját kulcsával.

GET /domains

A munkaterület minden domainje, a fogadási, küldési, követési és fájlállapotával együtt.

A fogadás és a küldés külön van

Minden domain két független állapotobjektumként jelenti a fogadást és a küldést. A receiving.verified azt jelenti, hogy a domain MX rekordja ide hozza a levelét, és a tulajdonlási kihívása közzé van téve, tehát a domain át tud venni kézbesítést. A kimenőről semmit nem mond.

A sending a kimenő fél, a domain tárolt aláírás-ellenőrzéséből olvasva, nem frissből. A sending.status értéke verified, pending, failed, no_identity vagy unknown lehet, a sending.canSend megmondja, elfogadnánk-e most a domainről induló küldést, a sending.checkedAt dátumozza ezt az ítéletet, a sending.error viszi az utolsó hibát, a sending.note pedig egy mondat, amely megmagyarázza az állapotot. Az egy napnál régebbi negatív ítéletet ismeretlennek tekintjük, nem elutasításnak, így a canSend igaz lehet, miközben a status pending.

A tracking egy harmadik objektum, amely a domain opcionális egyéni követési domainjéről szól, nem a leveléről. A tracking.status értéke none, amíg be nem állítasz egyet, akár az alkalmazásban, akár a PATCH /domains/{id} hívással, amelynek oldala minden mezőt leír.

A storage egy negyedik objektum ugyanazokkal a mezőkkel, a domain opcionális egyéni fájldomainjéről: arról a névről, amelyet a domainről küldött fájlok letöltési linkjei használnak. Ugyanígy és ugyanazon az oldalon állítható be, és a storage.status értéke none, amíg nincs beállítva.

Példa

domains:read szükséges hozzá.

curl
curl "$OE/domains" -H "$AUTH"
Válasz
{  "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"    }  ]}

A null lastCheckedAt azt jelenti, hogy a DNS-t még soha nem néztük meg: „még nem néztük”, nem „nem sikerült”. A kettő nagyon másként olvasódik harminc másodperccel egy domain hozzáadása után.