SDK

Installation

Ein Paket, keine Abhängigkeiten, jede Server-Laufzeitumgebung.

Installation

Die erste Veröffentlichung ist 0.0.1. Jede dokumentierte Operation hat eine Methode, die Paritätsprüfung des Pakets lässt den Build scheitern, wenn eine fehlt, und die gekapselte API ist in jeder Umgebung aktiv.

pnpm add @openemail/sdk

send-email.ts

import { 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 konfiguriert den gemeinsamen openemail-Client einmalig, und jedes Modul, das danach openemail importiert, erhält diesen Client. Lassen Sie es weg, dann baut der erste Aufruf den Client stattdessen aus OPENEMAIL_API_KEY.

Dass send() auflöst, bedeutet nicht, dass die Nachricht hinaus ist. Ein geplanter oder abbrechbarer Versand kommt als queued oder scheduled zurück und wird später abgeschlossen. Lesen Sie status und nicht die Tatsache, dass das Promise aufgelöst hat.

Wo es läuft

Keinerlei Laufzeitabhängigkeiten, auf Node 20+, Bun, Deno und Cloudflare Workers. Es nutzt das globale fetch und sonst nichts, und Sie können ihm ein eigenes übergeben.

ESM und CommonJS werden beide ausgeliefert, jeweils mit eigenen Typdeklarationen, daher funktionieren sowohl import { openemail } from '@openemail/sdk' als auch const { openemail } = require('@openemail/sdk').

Nicht im Browser. Der Client trägt einen Workspace-API-Schlüssel, der Mail senden und das Postfach lesen kann, er verweigert daher den Start dort, wo window und document existieren. Wegwerf-Posteingänge sind die Ausnahme: createTempMail() braucht keinen Schlüssel und läuft in einer Seite.

Dies ist ein **TypeScript/JavaScript**-Client, und es gibt kein Paket für Python, Go, PHP oder Ruby. Aus einer anderen Sprache heraus ist die API schlichtes HTTP und JSON: Der Schnellstart enthält eine funktionierende Anfrage in acht Sprachen, und das OpenAPI-Dokument erzeugt für die meisten übrigen einen Client.