Ieplānot un atcelt
Sūtiet vēlāk, pārceliet to vai apturiet.
Izpilda jebkuru no 2 izsaukumiem šajā lapā pret jūsu darbvietu, ar jūsu paša atslēgu.
Ieplānošana
scheduledAt pieņem ISO-8601 momentu vai ilgumu, piemēram, PT2H, līdz gadam uz priekšu. Ieplānots ziņojums atbild ar 202 un status: "scheduled" un paliek atceļams līdz pat brīdim, kad tas tiek nosūtīts.
cancellableForSeconds dara to pašu tūlītējam sūtījumam: sastādītāja atsaukšanas logs, kas ir atklāts, nevis piesaistīts lietotāja iestatījumam, kuram nav nekāda sakara ar API uzvedību. Abi ir savstarpēji izslēdzoši: ieplānots ziņojums jau tāpat ir atceļams.
Ieplānot sūtījumu
Divas stundas uz priekšu. Atbilde nes id, kas jums būs vajadzīgs, lai to pārceltu vai apturētu.
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" }'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, nevis 200: ar to vēl kaut kam jānotiek. Tūlītējs sūtījums atbild ar 200 un status: "sent", tāpēc izsaucējs var zarot tikai pēc statusa koda.
Pārcelt to
PATCH /emails/{id}. Mainīt var tikai scheduledAt, un tikai kamēr tas ir rindā vai ieplānots.
curl -X PATCH "$OE/emails/msg_8cd0a316930b4482a8b8440b" \ -H "$AUTH" -H "Content-Type: application/json" \ -d '{ "scheduledAt": "PT6H" }'{ "object": "email", "id": "msg_8cd0a316930b4482a8b8440b", "status": "scheduled", "scheduledAt": "2026-09-01T14:20:15.881Z" }Apturēt to
POST /emails/{id}/cancel.
curl -X POST "$OE/emails/msg_8cd0a316930b4482a8b8440b/cancel" -H "$AUTH"{ "object": "email", "id": "msg_8cd0a316930b4482a8b8440b", "status": "cancelled" }Atcelšana divreiz nav kļūda. Otrais izsaukums atgriež to pašu atcelto ziņojumu, tāpēc atkārtot ir droši.
Tāda atcelšana, kas jau aizgājis, ir 409 email_not_cancellable. To nevar nenosūtīt, un jebkura cita atbilde būtu meli.