Sign inGet Started

TypeScript · Astro

从 Astro API 路由使用 @messagebird/sdk 发送邮件。你需要一个 Bird API 密钥:在 Developers > API keys 中创建一个(发送第一封邮件有详细步骤),然后将其放入 .env 中,命名为 BIRD_API_KEY。

1. 安装

代码示例
npm create astro@latest my-app -- --template minimal --install --no-git --no-ai --yes
cd my-app
npm install @messagebird/sdk

2. 发送

创建 src/pages/api/send.ts。prerender = false 使该路由在服务器上按需渲染;Astro 通过 import.meta.env 暴露 .env 值,而 BIRD_API_KEY 没有 PUBLIC_ 前缀,因此它仅在服务器端可用:
代码示例
import type { APIRoute } from "astro";
import { BirdClient } from "@messagebird/sdk";

export const prerender = false;

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

export const POST: APIRoute = async () => {
  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 是 Bird 的共享入门发件人,delivered@messagebird.dev 是一个始终能送达的沙箱收件人:无需域名验证。SDK 会根据密钥的 bk_us1_ / bk_eu1_ 前缀推断区域(无需配置基础 URL),并在每次调用时自动生成一个 Idempotency-Key,因此重试发送是安全的。

3. 试一试

启动开发服务器并向该路由发送 POST 请求:
代码示例
npm run dev
curl -X POST http://localhost:4321/api/send
Bird 以 202 接受邮件并异步投递;你的路由返回 em_ ID 和状态:
代码示例
{
  "id": "em_01ky7ma8y2es1s2akzk53tmjn0",
  "status": "accepted"
}
要将按需路由部署到生产环境,需要添加服务器适配器,例如 @astrojs/node 或 @astrojs/vercel。纯静态构建无法运行按需路由。

后续步骤