SDK - OpenEmail

SDK

Een getypeerde TypeScript-client voor de OpenEmail API. Nul dependencies, en één methode voor elk endpoint.

Wat het is

Eén package over de hele API (verzenden, templates, tracking, threads, concepten, labels, contacten, audiences, domeinen, rules, webhooks, agenda, instellingen, rollen, leden en wegwerpinboxen) met types voor elk request en elke response, twee foutklassen, retries die een verzending niet kunnen dupliceren, en een verifier voor webhook-handtekeningen. Geen runtime-dependencies, ESM en CommonJS, op Node 20+, Bun, Deno en Cloudflare Workers. Hij draagt een workspace-key, dus hij draait op een server, en wegwerpinboxen zijn het enige onderdeel dat ook in een browser draait.

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>',})

Waar je heen kunt

InstallerenVoeg hem toe en verstuur je eerste bericht.ConfiguratieElke optie, en wat hij weigert.Een e-mail verzendenElk veld op een bericht.ThreadsLezen, ordenen, snoozen, bijlagen.WebhooksRegistreer een endpoint en verifieer het.FoutenWat er wordt gegooid, en hoe je het afbakent.RetriesWaarom een opnieuw geprobeerde verzending niet kan dupliceren.Elke methodeDe volledige lijst, één rij per stuk.

Het omwikkelt de API op het tabblad hiervoor

Alles hier is hetzelfde oppervlak dat de API-referentie documenteert, dus lees die voor wat een endpoint doet en deze voor hoe je het aanroept. Er is één methode voor elke gedocumenteerde operatie, en de pariteitscontrole van het package leest het OpenAPI-document om dat te bewijzen.

API-referentieWat elk endpoint doet, en hoe het faalt.