SDK

Kurulum

Tek paket, sıfır bağımlılık, her sunucu çalışma zamanı.

Kurulum

İlk sürüm 0.0.1'dir. Belgelenmiş her işlemin bir metodu vardır, paketin eşlik denetimi biri eksik olduğunda derlemeyi başarısız kılar ve sardığı API her ortamda açıktır.

pnpm add @openemail/sdk

send-email.ts

import { init, openemail } from '@openemail/sdk' init({ apiKey: process.env.OPENEMAIL_API_KEY }) const email = await openemail.emails.send({  from: 'Acme Billing <[email protected]>',  to: '[email protected]',  subject: 'Your September invoice',  html: '<p>Invoice attached.</p>',}) console.log(email.id, email.status)

init, paylaşılan openemail istemcisini bir kez yapılandırır ve sonrasında openemail'i içe aktaran her modül o istemciyi alır. Atlarsanız ilk çağrı istemciyi bunun yerine OPENEMAIL_API_KEY üzerinden kurar.

send() çağrısının çözülmesi mesajın gittiği anlamına gelmez. Zamanlanmış veya iptal edilebilir bir gönderim queued ya da scheduled olarak döner ve sonradan sonuçlanır. Promise'in çözülmüş olmasına değil status değerine bakın.

Nerede çalışır

Node 20+, Bun, Deno ve Cloudflare Workers üzerinde sıfır çalışma zamanı bağımlılığı. Global fetch dışında hiçbir şey kullanmaz ve isterseniz ona kendi fetch'inizi verebilirsiniz.

ESM ve CommonJS birlikte gelir, her biri kendi tip bildirimleriyle; dolayısıyla hem import { openemail } from '@openemail/sdk' hem de const { openemail } = require('@openemail/sdk') çalışır.

Tarayıcıda değil. İstemci, posta gönderebilen ve posta kutusunu okuyabilen bir çalışma alanı API anahtarı taşır; bu yüzden window ve document bulunan bir ortamda başlamayı reddeder. Tek kullanımlık gelen kutuları istisnadır: createTempMail() anahtar gerektirmez ve bir sayfada çalışır.

Bu bir **TypeScript/JavaScript** istemcisidir; Python, Go, PHP veya Ruby paketi yoktur. Başka bir dilden API düz HTTP ve JSON'dur: hızlı başlangıç sekiz dilde çalışan bir istek içerir ve OpenAPI belgesi geri kalanların çoğunda bir istemci üretir.