CLI

从 macOS 或 Linux 终端发送第一封邮件：安装 bird CLI，登录一次即可发送。无需复制 API 密钥。

1. 安装

代码示例

curl -fsSL https://cli.bird.com/install.sh | sh

运行 bird version 以确认安装成功。如需 Windows 及其他安装方式，请参阅安装 CLI。

2. 登录

代码示例

bird auth login --scope emails:write

此操作会打开浏览器授权页面，供你选择工作区并批准授权。emails:write 作用域允许第 3 步发送邮件。如果省略，bird auth login 仅请求只读访问权限，发送会被拒绝。CLI 将绑定工作区的 OAuth 令牌存储在 ~/.config/bird/credentials.json 中，在需要时自动刷新，并记录工作区所在区域。

3. 发送邮件

从 Bird 的共享入门域名发送到 delivered@messagebird.dev 沙箱地址：无需域名验证，无需真实邮箱。

代码示例

bird email send \
  --from onboarding@messagebird.dev \
  --to delivered@messagebird.dev \
  --subject "Hello from Bird" \
  --html "<p>My first Bird email.</p>"

CLI 将已接受的消息以 JSON 格式输出。*_count 字段跟踪收件人在各投递状态间的变化。在初始响应中，一个收件人已被接受，尚无投递完成：

代码示例

{
  "id": "em_01ky7ma8y2es1s2akzk53tmjn0",
  "status": "accepted",
  "category": "marketing",
  "from": { "email": "onboarding@messagebird.dev" },
  "to": [{ "email": "delivered@messagebird.dev" }],
  "subject": "Hello from Bird",
  "accepted_count": 1,
  "processed_count": 0,
  "delivered_count": 0,
  "deferred_count": 0,
  "bounced_count": 0,
  "complained_count": 0,
  "rejected_count": 0,
  "open_count": 0,
  "click_count": 0,
  "track_opens": true,
  "track_clicks": true,
  "created_at": "2026-07-23T13:58:20.866Z"
}

--to 可重复使用以指定多个收件人，--text 发送纯文本正文，--dry-run 输出解析后的请求但不实际发送。

4. 检查结果

accepted 表示 Bird 已接收消息并将异步投递。通过 em_ ID 读取该消息，观察状态变为 delivered：

代码示例

bird email get em_01ky7ma8y2es1s2akzk53tmjn0

添加 --format text 可输出易读的卡片视图，而非 JSON。

所有命令默认将 JSON 写入标准输出。错误使用标准错误上的 JSON 错误响应输出，退出码标识失败类别。完整约定请参阅面向 Agent 的 CLI。

后续步骤

CLI 参考：安装、身份验证、输出约定及主要命令组。
面向 Agent 的 CLI：JSON 输出、退出码、--dry-run 及幂等重试。
发送第一封邮件：通过原始 HTTP 和 SDK 完成相同流程。
发送域名：验证自有域名以用于生产环境发送。

CLI

1. 安装

2. 登录

3. 发送邮件

4. 检查结果

后续步骤

相关资源