TypeScript / Node.js

Envie um e-mail a partir de um script Node.js simples com @messagebird/sdk. Você precisa de uma chave Bird API: crie uma em Developers > Chaves API (Envie seu primeiro e-mail mostra como) e exporte-a como BIRD_API_KEY.

1. Instale

Exemplo de código

npm init -y
npm install @messagebird/sdk tsx

O SDK requer Node.js 20.3+ e é apenas ESM.

2. Enviar

Crie send.ts:

Exemplo de código

import { BirdClient } from "@messagebird/sdk";

const bird = new BirdClient({ apiKey: process.env.BIRD_API_KEY! });

const msg = await bird.email.send({
  from: { email: "onboarding@messagebird.dev", name: "Bird" },
  to: ["delivered@messagebird.dev"],
  subject: "Hello from Bird",
  html: "<p>My first Bird email.</p>",
});

console.log(msg.id, msg.status);

onboarding@messagebird.dev é o remetente compartilhado de onboarding do Bird e delivered@messagebird.dev é um destinatário sandbox que sempre entrega: não é necessária verificação de domínio. O SDK infere a região a partir do prefixo bk_us1_ / bk_eu1_ da sua chave (sem URL base para configurar) e gera automaticamente um Idempotency-Key por chamada, então reenvios são seguros.

3. Executar

Exemplo de código

npx tsx send.ts

O script imprime o ID da mensagem e o status:

Exemplo de código

em_01ky7ma8y2es1s2akzk53tmjn0 accepted

accepted é o 202 do API: Bird tem a mensagem e a entrega de forma assíncrona. Busque-a pelo em_ ID com bird.email.get(msg.id) e acompanhe o status mudar para delivered.

Próximos passos

TypeScript email SDK: a superfície completa de e-mail (send, get, list) e o modelo de erros.
Envie seu primeiro e-mail: criação de uma chave API e o conjunto completo de endereços sandbox.
Domínios de envio: verifique seu próprio domínio para envio em produção.
Referência de e-mail API: o esquema completo de requisição e resposta.

Recursos relacionados

Continue com a documentação, guias e exemplos sobre este tópico. Os recursos estão em inglês.

Assista ao guiaGetting started with email Entenda o conceitoShould I use a Bird SDK or call the API directly?Explore a funcionalidadeEmail Siga o percurso de aprendizagemBuild your first integration

Experimente na prática e obtenha um resumo de implementação