SDK
Un client TypeScript tipat per a l'API d'OpenEmail. Zero dependències, i un mètode per a cada endpoint.
Què és
Un sol paquet sobre tota l'API (enviament, plantilles, seguiment, converses, esborranys, etiquetes, contactes, audiències, dominis, regles, webhooks, calendari, configuració, rols, membres i bústies temporals) amb tipus per a cada petició i cada resposta, dues classes d'error, reintents que no poden duplicar un enviament, i un verificador de signatures de webhook. Sense dependències en temps d'execució, ESM i CommonJS, a Node 20+, Bun, Deno i Cloudflare Workers. Porta una clau d'espai de treball, de manera que s'executa en un servidor, i les bústies temporals són l'única part que també s'executa en un navegador.
pnpm add @openemail/sdkimport { init, openemail } from '@openemail/sdk' init({ apiKey: process.env.OPENEMAIL_API_KEY }) await openemail.emails.send({ from: 'Acme Billing <[email protected]>', to: '[email protected]', subject: 'Your September invoice', html: '<p>Invoice attached.</p>',})On anar
Embolcalla l'API de la pestanya anterior
Tot el que hi ha aquí és la mateixa superfície que documenta la referència de l'API, així que llegeix aquella per saber què fa un endpoint i aquesta per saber com cridar-lo. Hi ha un mètode per a cada operació documentada, i la comprovació de paritat del paquet llegeix el document OpenAPI per demostrar-ho.