Pular para o conteúdo principal
Começar

Quickstart

Do zero ao primeiro email entregue, em qualquer linguagem.

1. Crie uma chave de API

No painel, em Chaves de API, crie uma chave com escopo sending_access e guarde no ambiente. Escopos e autenticação

.env
COFFEEMAIL_API_KEY=cm_live_sua_chave

2. Verifique o domínio do remetente

Adicione o domínio e publique os registros de DNS. Enquanto isso, use o sandbox para testar. Guia de verificação de domínio

3. Instale o SDK

Escolha a linguagem. Todas têm a mesma superfície e o mesmo retorno com dados ou erro.

npm install @coffeemail/node

4. Envie o email

O email entra na fila e a resposta volta com o id em milissegundos.

import { CoffeeMail } from '@coffeemail/node'; const coffeemail = new CoffeeMail(process.env.COFFEEMAIL_API_KEY); const { data, error } = await coffeemail.emails.send({  from: 'Acme <pedidos@acme.com.br>',  to: 'ana@exemplo.com.br',  subject: 'Seu pedido #4821 foi enviado',  html: '<p>Chega amanhã.</p>',  idempotencyKey: 'pedido-4821-enviado',});
202 Accepted
{  "id": "8f3a2c1b-4d5e-4f60-9a7b-1c2d3e4f5a6b",  "status": "queued",  "queuedAt": "2026-11-10T17:02:11.204Z"}

5. Acompanhe a entrega

Receba os eventos (entregue, aberto, bounce) num webhook assinado ou consulte os eventos do email. Guia de webhooks