Belgelere geç
API

Şablonları listele

Bağlantıdaki her şablon, en yeniden başlayarak, anahtar kümesiyle sayfalanmış.

GETapi.openemail.uk/templates

Gerçek çağrıyı kendi anahtarınızla çalışma alanınıza karşı çalıştırır.

GET /templates

Bağlantıdaki her şablon, en yeniden başlayarak, anahtar kümesiyle sayfalanmış.

İki motor

shell
export OE=https://api.openemail.ukexport AUTH="Authorization: Bearer $OPENEMAIL_API_KEY"

Şablon, bir kez saklanıp çok kez gönderilen bir gövdedir ve onu yazana değil BAĞLANTIYA aittir. Bir çalışma alanı anahtarı, bir meslektaşınızın gördüğü şablonların aynısını görür ve yazarın hesabını silmek onları da götürmez.

engine: "blocks", düğüm türleri @react-email/components dışa aktarımları olan (Section, Row, Column, Container, Text, Heading, Button, Link, Img, Hr, Markdown, CodeBlock ve CodeInline) ve props'ları o bileşenlerin kendi props'ları olan bir ağaç saklar. Girişte doğrulanır, dolayısıyla hatalı bir düğüm sonradan bozuk bir e-posta değil, onu yazan çağrıda bir 422'dir.

engine: "html", elinizde zaten olan işaretlemeyi saklar ve sürüm yayımlandığında bir kez temizler. Şablonlarınız kendi deponuzda yaşayan react-email bileşenleriyse başvurulacak olan budur: bileşeni kendi derlemenizde @react-email/render ile render edin ve sonucu gönderin. Bir JSX uç noktası yoktur ve olmayacaktır. API, HTML alır çünkü bir posta istemcisinin okuduğu şey HTML'dir ve çağıranın bileşenini çalıştırmak, kimsenin ihtiyaç duymadığı bir kum havuzu getirirdi.

Şöyle bildirilirŞunun tarafından doldurulurGönderimde eksikse
`slots`şablonu düzenleyen kişiyuvanın kendi default değeri render edilir
`props`gönderen kişimissing_template_prop, bir 422, ve hiçbir posta çıkmaz

Her ikisi de gövdede ve konuda {{key}} olarak yazılır ve her ikisi de, değer yerine konurken nasıl kaçırılacağını belirleyen bir kind (text, url ya da image) taşır. Hiçbir şeyin bildirmediği bir anahtar yayımlamada hata verir; şeması http, https ya da mailto olmayan bir url değeri render edilmek yerine reddedilir.

Yayımlanmış bir sürüm dondurulur. Yayımlanmış bir şablonun gövdesini düzenlemek, canlı gönderimlerin çözümlediği şeyi değiştirmek yerine yeni bir taslak üretir; böylece metni yeniden yazan bir meslektaşınız kodunuzun hâlihazırda gönderdiğini değiştiremez ve version sabitlemek, o kişi yayımladığında da değiştiremeyeceği anlamına gelir.

Örnek

templates:read gerekir. limit 100'e kadar çıkar, status draft, active ya da archived olarak daraltır ve cursor opaktır; dolayısıyla kendiniz bir tane üretmek yerine size verilen nextCursor değerini geri geçin.

curl
curl "$OE/templates?limit=25&status=active" -H "$AUTH"
Yanıt
{  "object": "list",  "data": [    {      "object": "template",      "id": "tpl_9c1f0a4b7e05d3862c1f0a44",      "name": "Order shipped",      "slug": "order-shipped",      "description": null,      "status": "active",      "publishedVersion": 3,      "latestVersion": 4,      "createdAt": "2026-08-01T09:12:44.000Z",      "updatedAt": "2026-08-28T16:03:10.000Z"    }  ],  "hasMore": false,  "nextCursor": null}

publishedVersion, version verilmeden yapılan bir gönderimin çözümlediği şeydir; latestVersion ise onun üzerinde duran taslaktır. İkisinin farklı olması, birinin düzenleyip yayımlamadığı anlamına gelir. Bu bir hata değildir ve bir dağıtım kaydında belirtilmeye değer.

Bir satır meta veridir. Bildirilen slots ve props tekil getirmeden döner ki bir şablona ne geçeceğinizi bilmeniz gerektiğinde yapılacak çağrı odur.