Zur Dokumentation springen
SDK

SDK

Ein typisierter TypeScript-Client für die OpenEmail-API. Keine Abhängigkeiten und eine Methode für jeden Endpunkt.

Was es ist

Ein Paket über die gesamte API (Senden, Vorlagen, Tracking, Threads, Entwürfe, Labels, Kontakte, Audiences, Domains, Regeln, Webhooks, Kalender, Einstellungen, Rollen, Mitglieder und Wegwerf-Postfächer) mit Typen für jede Anfrage und jede Antwort, zwei Fehlerklassen, Wiederholungen, die einen Versand nicht verdoppeln können, und einem Prüfer für Webhook-Signaturen. Keine Laufzeitabhängigkeiten, ESM und CommonJS, auf Node 20+, Bun, Deno und Cloudflare Workers. Es trägt einen Workspace-Key, läuft also auf einem Server; Wegwerf-Postfächer sind der eine Teil, der auch im Browser läuft.

pnpm add @openemail/sdk
send-email.ts
import { 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>',})

Wohin als Nächstes

Es kapselt die API aus dem Reiter davor

Alles hier ist dieselbe Oberfläche, die die API-Referenz dokumentiert; lesen Sie dort, was ein Endpunkt tut, und hier, wie man ihn aufruft. Es gibt eine Methode für jede dokumentierte Operation, und die Parity-Prüfung des Pakets liest das OpenAPI-Dokument, um das nachzuweisen.