Sign inGet Started

TypeScript / Node.js

使用 @messagebird/sdk 从普通 Node.js 脚本发送邮件。你需要一个 Bird API 密钥:在 Developers > API keys 中创建一个(发送第一封邮件有详细步骤),然后将其导出为 BIRD_API_KEY。

1. 安装

代码示例
npm init -y
npm install @messagebird/sdk tsx
SDK 需要 Node.js 20.3 或更高版本,且仅支持 ESM。

2. 发送

创建 send.ts:
代码示例
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 是 Bird 的共享入门发件人,delivered@messagebird.dev 是始终可送达的沙盒收件人:无需域名验证。SDK 根据密钥的 bk_us1_ / bk_eu1_ 前缀推断区域(无需配置基础 URL),并在每次调用时自动生成 Idempotency-Key,因此重试发送是安全的。

3. 运行

代码示例
npx tsx send.ts
脚本会打印消息 ID 和状态:
代码示例
em_01ky7ma8y2es1s2akzk53tmjn0 accepted
accepted 是 API 的 202:Bird 已收到消息并异步投递。通过 bird.email.get(msg.id) 使用 em_ ID 获取消息,可以看到状态变为 delivered。

后续步骤