TypeScript / Node.js

Envoyez un e-mail depuis un script Node.js simple avec @messagebird/sdk. Vous avez besoin d'une clé Bird API : créez-en une dans Developers > Clés API (Envoyer votre premier e-mail décrit la procédure), puis exportez-la en tant que BIRD_API_KEY.

1. Installation

Exemple de code

npm init -y
npm install @messagebird/sdk tsx

Le SDK nécessite Node.js 20.3+ et est uniquement ESM.

2. Envoyer

Créez send.ts :

Exemple de code

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 est l'expéditeur d'intégration partagé de Bird et delivered@messagebird.dev est un destinataire sandbox qui aboutit toujours : aucune vérification de domaine nécessaire. Le SDK déduit la région à partir du préfixe bk_us1_ / bk_eu1_ de votre clé (aucune URL de base à configurer) et génère automatiquement un Idempotency-Key par appel, ce qui rend les envois réessayés sûrs.

3. Exécuter

Exemple de code

npx tsx send.ts

Le script affiche l'identifiant du message et son statut :

Exemple de code

em_01ky7ma8y2es1s2akzk53tmjn0 accepted

accepted est le 202 du API : Bird détient le message et le distribue de manière asynchrone. Récupérez-le par son identifiant em_ avec bird.email.get(msg.id) et observez le statut passer à delivered.

Étapes suivantes

TypeScript email SDK : la surface email complète (send, get, list) et le modèle d'erreur.
Envoyer votre premier e-mail : créer une clé API et l'ensemble complet des adresses sandbox.
Domaines d'envoi : vérifiez votre propre domaine pour l'envoi en production.
Référence email API : le schéma complet de requête et de réponse.

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet. Les ressources sont en anglais.

Regarder le guideGetting started with email Comprendre le conceptShould I use a Bird SDK or call the API directly?Explorer la fonctionnalitéEmail Suivre le parcours d'apprentissageBuild your first integration

Essayez la pratique et obtenez un guide d'implémentation