API

Zamanlama ve iptal

Sonra gönderin, zamanını değiştirin ya da durdurun.

PATCHapi.openemail.uk/emails/{id}

Bu sayfadaki 2 çağrının herhangi birini kendi anahtarınızla çalışma alanınıza karşı çalıştırır.

Zamanlama

scheduledAt, ISO-8601 bir an ya da PT2H gibi bir süre alır; en çok bir yıl ileriye. Zamanlanmış bir ileti status: "scheduled" ile 202 yanıtı verir ve gönderilene kadar iptal edilebilir kalır.

cancellableForSeconds aynı şeyi anında gönderim için yapar: yazma penceresinin geri alma süresi, bir API'nin davranışına karar vermesi haddine olmayan bir kullanıcı ayarına gömülmek yerine dışarıya açılmıştır. İkisi birbirini dışlar: zamanlanmış bir ileti zaten iptal edilebilir.

Gönderimi zamanlama

İki saat sonrası. Yanıt, iletinin zamanını değiştirmek ya da onu durdurmak için gerekecek id'yi taşır.

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"    }'

Yanıt

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  }

200 değil 202: hâlâ olması gereken bir şey var. Anında gönderim status: "sent" ile 200 yanıtı verir; böylece çağıran yalnızca durum koduna göre dallanabilir.

Zamanını değiştirme

PATCH /emails/{id}. Yalnızca scheduledAt değişebilir ve yalnızca ileti kuyruktayken ya da zamanlanmışken.

curl

curl -X PATCH "$OE/emails/msg_8cd0a316930b4482a8b8440b" \    -H "$AUTH" -H "Content-Type: application/json" \    -d '{ "scheduledAt": "PT6H" }'

Yanıt

{    "object": "email",    "id": "msg_8cd0a316930b4482a8b8440b",    "status": "scheduled",    "scheduledAt": "2026-09-01T14:20:15.881Z"  }

Durdurma

POST /emails/{id}/cancel.

curl

curl -X POST "$OE/emails/msg_8cd0a316930b4482a8b8440b/cancel" -H "$AUTH"

Yanıt

{ "object": "email", "id": "msg_8cd0a316930b4482a8b8440b", "status": "cancelled" }

İki kez iptal etmek hata değildir. İkinci çağrı aynı iptal edilmiş iletiyi döndürür; bu yüzden yeniden deneme güvenlidir.

Çoktan gitmiş bir iletiyi iptal etmek 409 email_not_cancellable verir. Gönderilmiş bir ileti geri alınamaz ve başka bir yanıt vermek yalan olurdu.