快速上手
注册账号、验证域名、创建 API 密钥,用 curl 或 Node.js SDK 发出第一封邮件,再用 SES 邮箱模拟器测试。
1. 注册
在 billionsend.com 创建账号。控制台就在这里,API 地址是 https://api.billionsend.com。
2. 验证域名
只能用已验证的域名发信。
- 打开域名,添加你拥有的域名,例如
acme.dev。 - 在 DNS 服务商处添加页面上显示的 DNS 记录(DKIM 和 MAIL FROM)。
- 点击验证域名。页面会显示还缺哪些记录。
详见域名。
3. 创建 API 密钥
打开 API 密钥并创建一个。以 bs_ 开头的密钥只显示一次,请复制保存。密钥可以是完全访问或仅发送,并可限定为某一个域名。
4. 发送邮件
用 curl:
curl -X POST https://api.billionsend.com/emails \
-H "Authorization: Bearer bs_..." \
-H "Content-Type: application/json" \
-d '{
"from": "Acme <onboarding@acme.dev>",
"to": ["success@simulator.amazonses.com"],
"subject": "Hello from BillionSend",
"html": "<strong>It works!</strong>"
}'
或用 Node.js SDK(npm install @billionsend/node):
import { BillionSend } from "@billionsend/node";
const bs = new BillionSend("bs_..."); // 设置了 BILLIONSEND_API_KEY 时,也可以直接用 new BillionSend()
const { data, error } = await bs.emails.send({
from: "Acme <onboarding@acme.dev>",
to: ["success@simulator.amazonses.com"],
subject: "Hello from BillionSend",
html: "<strong>It works!</strong>",
});
if (error) console.error(error.name, error.message);
else console.log("sent", data.id);
两种方式都会返回 { "id": "..." }。在邮件页面可以看到这封邮件从 queued 变为 delivered。其他语言见 SDK。
测试
success@simulator.amazonses.com会模拟一次送达,不会真的发给任何人。加上标签可以区分不同测试:success+signup@simulator.amazonses.com。- 模拟器邮件仍然计入套餐额度。
- 模拟器的
bounce@、complaint@和suppressionlist@会产生真实的退信与投诉:地址会被加入你的抑制列表,事件也会触发你的 Webhook,但模拟器反馈不会计入你的退信率和投诉率。只用于手动测试,不要放进自动化测试。每个地址只能用一次,换新地址时加个标签:bounce+2@simulator.amazonses.com。 example.com下的地址,以及.test或.invalid域名下的地址都收不到邮件。发往这些地址的请求会被拒绝并返回422(见 API 基础)。