Instal·lació
Un sol paquet, sense dependències, per a tots els entorns d'execució de servidor.
Instal·lació
La primera versió és 0.0.1. Cada operació documentada té un mètode, la comprovació de paritat del paquet fa fallar la compilació quan en falta un, i l'API que embolcalla està activa a tots els entorns.
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)init configura una sola vegada el client compartit openemail, i tots els mòduls que després importin openemail obtenen aquest client. Si te'l saltes, la primera crida construeix el client a partir d'OPENEMAIL_API_KEY.
Que send() es resolgui no vol dir que el missatge hagi sortit. Un enviament programat o cancel·lable torna com a queued o scheduled i es resol més tard. Llegeix status, no el fet que la promesa s'hagi resolt.
On funciona
Zero dependències en temps d'execució, sobre Node 20+, Bun, Deno i Cloudflare Workers. Fa servir el fetch global i res més, i li pots passar el teu.
S'inclouen tant ESM com CommonJS, cadascun amb les seves pròpies declaracions de tipus, de manera que tant import { openemail } from '@openemail/sdk' com const { openemail } = require('@openemail/sdk') funcionen.
Al navegador no. El client porta una clau d'API de l'espai de treball que pot enviar correu i llegir la bústia, de manera que es nega a arrencar allà on existeixen window i document. Les bústies d'un sol ús són l'excepció: createTempMail() no necessita cap clau i funciona dins d'una pàgina.
Això és un client de **TypeScript/JavaScript**, i no hi ha cap paquet de Python, Go, PHP ni Ruby. Des d'un altre llenguatge, l'API és HTTP i JSON i prou: la guia d'inici ràpid inclou una petició funcional en vuit llenguatges, i el document OpenAPI genera un client per a la majoria de la resta.