TypeScript · Remix

Wyślij e-mail z akcji trasy Remix za pomocą @messagebird/sdk. Potrzebujesz klucza Bird API: utwórz go w Developers > API keys (Wyślij pierwszy e-mail przeprowadzi Cię przez ten proces), a następnie umieść go w .env jako BIRD_API_KEY.

1. Zainstaluj

Przykład kodu

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

2. Wyślij

Utwórz app/routes/send.ts, resource route, której action działa tylko na serwerze:

Przykład kodu

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 to współdzielony nadawca onboardingowy Bird, a delivered@messagebird.dev to odbiorca sandboxowy, do którego wiadomości zawsze docierają: weryfikacja domeny nie jest potrzebna. SDK rozpoznaje region na podstawie prefiksu bk_us1_ / bk_eu1_ Twojego klucza (nie trzeba konfigurować bazowego URL-a) i automatycznie generuje Idempotency-Key dla każdego wywołania, więc ponowne wysyłki są bezpieczne.

3. Wypróbuj

Uruchom serwer deweloperski i wyślij POST do trasy:

Przykład kodu

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

Bird przyjmuje e-mail z kodem 202 i dostarcza go asynchronicznie; Twoja trasa zwraca ID em_ i status:

Przykład kodu

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

Następne kroki

TypeScript email SDK: pełna powierzchnia e-mail (send, get, list) i model błędów.
Wyślij pierwszy e-mail: tworzenie klucza API i pełny zestaw adresów sandboxowych.
Domeny wysyłkowe: zweryfikuj własną domenę do wysyłki produkcyjnej.
Dokumentacja e-mail API: pełny schemat żądania i odpowiedzi.

Powiązane zasoby

Kontynuuj z dokumentacją, przewodnikami i przykładami dotyczącymi tego tematu. Zasoby są w języku angielskim.

Obejrzyj przewodnikGetting started with email Zrozum koncepcjęShould I use a Bird SDK or call the API directly?Poznaj możliwościEmail Podążaj ścieżką naukiBuild your first integration

Wypróbuj ćwiczenie i uzyskaj brief wdrożeniowy