@abmail/send
v1.2.0
Published
SDK oficial para integração de e-mails da API ABMail
Readme
@abmail/send (v1.2.0)
SDK Oficial da Abdala Mail para integração de e-mails via API v2.
Novidades da v1.2.0
- Agendamento Nativo: Envie e-mails com atraso de até 10 horas.
- Batch Sending: Envie até 50 e-mails em uma única requisição.
- Webhooks API: Gerencie seus webhooks diretamente pelo SDK.
- Anexos via URL: Passe apenas o
pathe deixe o servidor processar. - Inline Images (CID): Suporte total a imagens embutidas no corpo do e-mail.
Uso Básico
import { ABMail } from "@abmail/send";
const mail = new ABMail("abmail_sk_SeuToken");
// Envio Simples
await mail.emails.send({
from: "Suporte <[email protected]>",
to: "[email protected]",
subject: "Bem-vindo",
html: "<h1>Olá!</h1>"
});Recursos Enterprise
1. Agendamento (scheduled_at)
Aceita formato ISO ou linguagem natural.
await mail.emails.send({
// ...
scheduled_at: "in 2 hours" // Envia daqui a 2 horas
});2. Envio em Massa (Batch)
Economize latência enviando múltiplos e-mails de uma vez.
const result = await mail.emails.sendBatch([
{ to: "[email protected]", subject: "Oi 1", html: "..." },
{ to: "[email protected]", subject: "Oi 2", html: "..." }
]);3. Imagens Inline (CID)
await mail.emails.send({
from: "...",
to: "...",
subject: "Logo da Empresa",
html: '<img src="cid:logo_empresa">',
attachments: [
{
filename: "logo.png",
content: "...", // Base64
content_id: "logo_empresa",
disposition: "inline"
}
]
});4. Anexos via URL
await mail.emails.send({
// ...
attachments: [
{
filename: "manual.pdf",
path: "https://site.com/arquivos/manual.pdf"
}
]
});5. Gerenciamento de Webhooks
// Criar
await mail.webhooks.create("https://meu-app.com/api/webhook", ["email.delivered", "email.opened"]);
// Listar
const webhooks = await mail.webhooks.list();
// Deletar
await mail.webhooks.delete("webhook_id_123");Tipagem Completa
O SDK é escrito em TypeScript e fornece tipos para todas as respostas e opções, incluindo ABMailResponse, ABMailBatchResponse e ABMailWebhook.
