Перейти к документации
SDK

SDK

Типизированный клиент на TypeScript для API OpenEmail. Ноль зависимостей и один метод на каждый эндпоинт.

Что это

Один пакет на весь API (отправка, шаблоны, отслеживание, переписки, черновики, метки, контакты, аудитории, домены, правила, вебхуки, календарь, настройки, роли, участники и одноразовые ящики) с типами для каждого запроса и ответа, двумя классами ошибок, повторами, которые не могут продублировать отправку, и проверщиком подписи вебхуков. Никаких зависимостей в рантайме, ESM и CommonJS, на Node 20+, Bun, Deno и Cloudflare Workers. Он несёт ключ рабочего пространства, поэтому работает на сервере, а одноразовые ящики — единственная часть, которая работает ещё и в браузере.

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

Куда идти дальше

Он оборачивает API с предыдущей вкладки

Всё здесь — та же поверхность, что документирует справочник API, поэтому читайте его о том, что делает эндпоинт, а это — о том, как его вызвать. На каждую документированную операцию есть один метод, и проверка паритета в пакете читает документ OpenAPI, чтобы это доказать.