SDK

Instalace

Jeden balíček, žádné závislosti, každé serverové běhové prostředí.

Instalace

První vydání je 0.0.1. Každá zdokumentovaná operace má metodu, kontrola parity v balíčku shodí build, jakmile některá chybí, a API, které balíček obaluje, je zapnuté v každém prostředí.

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 nakonfiguruje sdíleného klienta openemail jednou a každý modul, který openemail potom importuje, dostane právě tohoto klienta. Když to přeskočíte, první volání si klienta sestaví z OPENEMAIL_API_KEY.

To, že se send() vyřeší, neznamená, že zpráva odešla. Naplánované nebo zrušitelné odeslání se vrací jako queued nebo scheduled a dokončí se později. Řiďte se status, ne tím, že se promise vyřešila.

Kde běží

Nula běhových závislostí, na Node 20+, Bun, Deno a Cloudflare Workers. Používá globální fetch a nic jiného a můžete mu předat i vlastní.

Dodává se ESM i CommonJS, každý s vlastními deklaracemi typů, takže funguje import { openemail } from '@openemail/sdk' i const { openemail } = require('@openemail/sdk').

Ne v prohlížeči. Klient nese API klíč pracovního prostoru, který umí odesílat poštu a číst schránku, takže tam, kde existují window a document, odmítne nastartovat. Výjimkou jsou jednorázové schránky: createTempMail() žádný klíč nepotřebuje a běží i na stránce.

Tohle je klient pro **TypeScript/JavaScript**; balíček pro Python, Go, PHP ani Ruby neexistuje. Z jiného jazyka je API prosté HTTP a JSON: rychlý start obsahuje funkční požadavek v osmi jazycích a z dokumentu OpenAPI se dá vygenerovat klient pro většinu zbývajících.