Telepítés
Egy csomag, nulla függőség, minden szerveroldali futtatókörnyezet.
Telepítés
Az első kiadás a 0.0.1. Minden dokumentált művelethez tartozik metódus, a csomag paritásellenőrzése megbuktatja a buildet, ha valamelyik hiányzik, és a becsomagolt API minden környezetben él.
pnpm add @openemail/sdkimport { 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)Az init egyszer állítja be a megosztott openemail klienst, és onnantól minden modul, amely importálja az openemail-t, ezt a klienst kapja. Ha kihagyod, az első hívás az OPENEMAIL_API_KEY alapján építi fel a klienst.
A send() teljesülése nem jelenti azt, hogy az üzenet elment. Az ütemezett vagy visszavonható küldés queued vagy scheduled állapottal tér vissza, és csak később dől el. A status mezőt olvasd, ne azt, hogy a promise teljesült.
Hol fut
Nulla futásidejű függőség Node 20+, Bun, Deno és Cloudflare Workers alatt. Kizárólag a globális fetch-et használja, és sajátot is átadhatsz neki.
ESM és CommonJS egyaránt része a csomagnak, mindkettő saját típusdefiníciókkal, így az import { openemail } from '@openemail/sdk' és a const { openemail } = require('@openemail/sdk') is működik.
Böngészőben nem. A kliens olyan munkaterületi API-kulcsot hordoz, amellyel levelet lehet küldeni és a postafiókot olvasni, ezért nem hajlandó elindulni ott, ahol létezik a window és a document. Az eldobható postafiókok a kivételek: a createTempMail() nem igényel kulcsot, és oldalon belül is fut.
Ez egy **TypeScript/JavaScript** kliens, és nincs Python-, Go-, PHP- vagy Ruby-csomag. Más nyelvből nézve az API egyszerű HTTP és JSON: a gyorsindító nyolc nyelven tartalmaz működő kérést, az OpenAPI-dokumentumból pedig a többi nagy részéhez generálható kliens.