Ir a la documentación
SDK

SDK

Un cliente TypeScript tipado para la API de OpenEmail. Cero dependencias y un método por cada endpoint.

Qué es

Un solo paquete sobre toda la API (envío, plantillas, seguimiento, conversaciones, borradores, etiquetas, contactos, audiencias, dominios, reglas, webhooks, calendario, ajustes, roles, miembros y buzones desechables) con tipos para cada petición y cada respuesta, dos clases de error, reintentos que no pueden duplicar un envío y un verificador de firmas de webhook. Sin dependencias en tiempo de ejecución, ESM y CommonJS, en Node 20+, Bun, Deno y Cloudflare Workers. Lleva una clave de espacio de trabajo, así que se ejecuta en un servidor, y los buzones desechables son la única parte que también funciona en un navegador.

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

A dónde ir

Envuelve la API de la pestaña anterior a esta

Todo lo de aquí es la misma superficie que documenta la referencia de la API, así que lee aquella para saber qué hace un endpoint y esta para saber cómo llamarlo. Hay un método por cada operación documentada, y la comprobación de paridad del paquete lee el documento OpenAPI para demostrarlo.