SDK
Um cliente TypeScript tipado para a API da OpenEmail. Zero dependências, e um método para cada endpoint.
O que é
Um pacote para toda a API (envio, modelos, rastreio, conversas, rascunhos, etiquetas, contactos, audiências, domínios, regras, webhooks, calendário, definições, funções, membros e caixas de entrada descartáveis) com tipos para cada pedido e cada resposta, duas classes de erro, repetições que não podem duplicar um envio, e um verificador de assinaturas de webhook. Sem dependências em tempo de execução, ESM e CommonJS, em Node 20+, Bun, Deno e Cloudflare Workers. Transporta uma chave de espaço de trabalho, por isso corre num servidor, e as caixas de entrada descartáveis são a única parte que também corre num navegador.
pnpm add @openemail/sdkimport { 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>',})Por onde ir
Envolve a API do separador anterior a este
Tudo aqui é a mesma superfície que a referência da API documenta, por isso leia essa para saber o que faz um endpoint e esta para saber como o chamar. Há um método para cada operação documentada, e a verificação de paridade do pacote lê o documento OpenAPI para o provar.