Installeren
Eén package, geen afhankelijkheden, elke serverruntime.
Installeren
De eerste release is 0.0.1. Elke gedocumenteerde operatie heeft een methode, de pariteitscontrole van het package laat de build falen wanneer er een ontbreekt, en de API die het omhult staat in elke omgeving aan.
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 configureert de gedeelde openemail-client één keer, en elke module die daarna openemail importeert krijgt die client. Sla het over en de eerste aanroep bouwt de client in plaats daarvan uit OPENEMAIL_API_KEY.
Dat send() oplost betekent niet dat het bericht weg is. Een geplande of annuleerbare verzending komt terug als queued of scheduled en beslecht zich later. Lees status, niet het feit dat de promise oploste.
Waar het draait
Nul runtime-afhankelijkheden, op Node 20+, Bun, Deno en Cloudflare Workers. Het gebruikt de globale fetch en verder niets, en je kunt het je eigen meegeven.
ESM en CommonJS worden allebei meegeleverd, elk met eigen typedeclaraties, dus zowel import { openemail } from '@openemail/sdk' als const { openemail } = require('@openemail/sdk') werkt.
Niet in een browser. De client draagt een workspace-API-sleutel die mail kan versturen en de mailbox kan lezen, dus hij weigert te starten waar window en document bestaan. Wegwerpinboxen zijn de uitzondering: createTempMail() heeft geen sleutel nodig en draait in een pagina.
Dit is een **TypeScript/JavaScript**-client, en er is geen package voor Python, Go, PHP of Ruby. Vanuit een andere taal is de API gewoon HTTP en JSON: de quickstart bevat een werkend verzoek in acht talen, en het OpenAPI-document genereert een client in de meeste overige.