TypeScript · Remix

Envie um e-mail a partir de uma route action do Remix com @messagebird/sdk. Você precisa de uma chave Bird API: crie uma em Developers > Chaves API (Envie seu primeiro e-mail mostra como) e coloque-a em .env como BIRD_API_KEY.

1. Instale

Exemplo de código

npx create-remix@latest my-app && cd my-app
npm install @messagebird/sdk

2. Envie

Crie app/routes/send.ts, uma resource route cuja action roda apenas no servidor:

Exemplo de código

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

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

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

  console.log(msg.id, msg.status); // "em_…", "accepted"
  return Response.json({ id: msg.id, status: msg.status });
}

onboarding@messagebird.dev é o remetente compartilhado de onboarding da Bird e delivered@messagebird.dev é um destinatário sandbox que sempre entrega: não é necessário verificar o 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. Teste

Inicie o servidor de desenvolvimento e faça POST para a rota:

Exemplo de código

npm run dev
curl -X POST http://localhost:5173/send

Bird aceita o e-mail com um 202 e o entrega de forma assíncrona; sua rota retorna o ID e o status do em_:

Exemplo de código

{
  "id": "em_01ky7ma8y2es1s2akzk53tmjn0",
  "status": "accepted"
}

Próximos passos

E-mail com TypeScript SDK: a superfície completa de e-mail (send, get, list) e o modelo de erro.
Envie seu primeiro e-mail: como criar 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 schema 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