Installation
Un seul package, aucune dépendance, tous les runtimes serveur.
Installation
La première version est 0.0.1. Chaque opération documentée a une méthode, le contrôle de parité du package fait échouer le build dès qu'il en manque une, et l'API qu'il enveloppe est active dans tous les environnements.
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 configure une fois pour toutes le client openemail partagé, et tout module qui importe openemail ensuite obtient ce client. Sautez cette étape et le premier appel construira le client à partir d'OPENEMAIL_API_KEY.
La résolution de send() ne signifie pas que le message est parti. Un envoi planifié ou annulable revient en queued ou scheduled et se règle plus tard. Lisez status, pas le fait que la promesse ait été résolue.
Où il s'exécute
Zéro dépendance à l'exécution, sur Node 20+, Bun, Deno et Cloudflare Workers. Il utilise le fetch global et rien d'autre, et vous pouvez lui fournir le vôtre.
ESM et CommonJS sont tous deux livrés, chacun avec ses propres déclarations de types : import { openemail } from '@openemail/sdk' et const { openemail } = require('@openemail/sdk') fonctionnent donc l'un comme l'autre.
Pas dans un navigateur. Le client porte une clé d'API de workspace capable d'envoyer du courrier et de lire la boîte : il refuse donc de démarrer là où window et document existent. Les boîtes jetables font exception : createTempMail() n'a besoin d'aucune clé et s'exécute dans une page.
Ceci est un client **TypeScript/JavaScript**, et il n'existe pas de package Python, Go, PHP ou Ruby. Depuis un autre langage, l'API est du simple HTTP et du JSON : le guide de démarrage contient une requête fonctionnelle en huit langages, et le document OpenAPI génère un client dans la plupart des autres.