Ugrás a dokumentációra
API

Ütemezés és visszavonás

Küldés később, áthelyezés vagy leállítás.

PATCHapi.openemail.uk/emails/{id}

Az oldalon lévő 2 hívás bármelyikét lefuttatja a munkaterületén, a saját kulcsával.

Ütemezés

A scheduledAt egy ISO-8601 időpontot vagy egy időtartamot vesz át, például PT2H, legfeljebb egy évre előre. Az ütemezett üzenet 202 választ ad status: "scheduled" értékkel, és egészen az elküldéséig visszavonható marad.

A cancellableForSeconds ugyanezt teszi egy azonnali küldésnél: ez a szerkesztő visszavonási ablaka, kiajánlva ahelyett, hogy egy felhasználói beállításba lenne huzalozva, amelynek semmi köze nincs egy API viselkedésének eldöntéséhez. A kettő kizárja egymást: az ütemezett üzenet már eleve visszavonható.

Küldés ütemezése

Két órával későbbre. A válasz viszi azt az azonosítót, amelyre az áthelyezéshez vagy a leállításhoz szükséged lesz.

curl
curl -X POST "$OE/emails" -H "$AUTH" -H "Content-Type: application/json" \    -d '{      "from": "[email protected]",      "to": ["[email protected]"],      "subject": "Your September invoice",      "html": "<p>Invoice attached.</p>",      "scheduledAt": "PT2H"    }'
Válasz
HTTP/1.1 202 Accepted  Location: /emails/msg_8cd0a316930b4482a8b8440b   {    "object": "email",    "id": "msg_8cd0a316930b4482a8b8440b",    "status": "scheduled",    "scheduledAt": "2026-09-01T10:19:41.345Z",    "cancellableUntil": "2026-09-01T10:19:41.345Z",    "messageId": null,    "transport": null,    "sentAt": null  }

202, nem 200: még történnie kell vele valaminek. Az azonnali küldés 200 választ ad status: "sent" értékkel, így a hívó pusztán a státuszkód alapján is elágazhat.

Áthelyezés

PATCH /emails/{id}. Csak a scheduledAt változtatható, és csak amíg az üzenet sorban áll vagy ütemezve van.

curl
curl -X PATCH "$OE/emails/msg_8cd0a316930b4482a8b8440b" \    -H "$AUTH" -H "Content-Type: application/json" \    -d '{ "scheduledAt": "PT6H" }'
Válasz
{    "object": "email",    "id": "msg_8cd0a316930b4482a8b8440b",    "status": "scheduled",    "scheduledAt": "2026-09-01T14:20:15.881Z"  }

Leállítás

POST /emails/{id}/cancel.

curl
curl -X POST "$OE/emails/msg_8cd0a316930b4482a8b8440b/cancel" -H "$AUTH"
Válasz
{ "object": "email", "id": "msg_8cd0a316930b4482a8b8440b", "status": "cancelled" }

A kétszeri visszavonás nem hiba. A második hívás ugyanazt a visszavont üzenetet adja vissza, így az újrapróbálkozás biztonságos.

A már elment üzenet visszavonása 409 email_not_cancellable. Nem lehet el nem küldeni, és bármi más válasz hazugság lenne.