@crvouga/ mockingbird-service-resend 页面存档备份,存于互联网档案馆

本地模拟器。 真正的API合同. 部分 嘲笑鸟。 。 。 .

国家模拟器 重新发送 电子邮件 API 用于测试套房 。 每一个送货者都会在 发件箱 测试改为:GET /__admin/outbox,以及每个电子邮件中的链接). Idempotency-Key 重播 返回第一个发送的ID。 以 Svix 签名存储和宣布入境邮件 email.received webhook,和收到的电子邮件端点服务于其内容和 附录。 与 --forward-to-inbox,每个发送的电子邮件也会被复制到 Maliosaur 模拟器,所以一个收件箱 持有每个代码和链接.

• 行动范围: 支助
• openapi.yaml 从Resend公布的 API 引用到 [email protected] 财务报告和审定财务报表 我们的后端电话.

安装

npm install -D @crvouga/mockingbird-service-resend

仅限无害环境管理。 节点 22或 Bun 1.2. 无土生属地. 给它服务 npx mockingbird-resend serve, (中文(简体) ), createServer 从 ./server (节点),或 createRuntime 与 任何获取服务器.

使用量

[email protected] 读取 RESEND_BASE_URL 当模块首次被导入时设置在 应用程序的环境(或第一个程序之前) import("resend") 在测试中。 设置应用程序 RESEND_INBOUND_WEBHOOK_SECRET 并通过同样的 whsec_… 值为 --webhook-secret。 。 。 .

npx mockingbird-resend serve --port 8794 \
  --webhook-url http://127.0.0.1:3000/messaging/inbound/email \
  --webhook-secret "$RESEND_INBOUND_WEBHOOK_SECRET" \
  --forward-to-inbox http://127.0.0.1:8793
RESEND_BASE_URL=http://127.0.0.1:8794 node app.js

import { createServer } from "@crvouga/mockingbird-service-resend/server"

// Test setup: the emulator, and the base URL the Resend SDK reads at import.
const emulator = await createServer()
process.env.RESEND_BASE_URL = emulator.url
const { Resend } = await import("resend")

// The app's own Resend call.
await new Resend("re_test").emails.send({
  from: "Acme <[email protected]>",
  to: ["[email protected]"],
  subject: "You're invited",
  html: '<a href="https://app.test/family/invitations/claim?token=abc">Join</a>',
})

// The test reads the mail back from the outbox.
const { messages } = await (await fetch(`${emulator.url}/__admin/[email protected]`)).json()
const { links } = await (await fetch(`${emulator.url}/__admin/outbox/${messages[0].id}/links`)).json()
// links[0] === "https://app.test/family/invitations/claim?token=abc"
await emulator.close()

发件箱是每次发送的断言表层. 一个 idempotencyKey 回放第一个 发送身份证明 并留下一个信息:

import { createServer } from "@crvouga/mockingbird-service-resend/server"

const emulator = await createServer()
process.env.RESEND_BASE_URL = emulator.url
const { Resend } = await import("resend")

const resend = new Resend("re_test")
const email = { from: "[email protected]", to: ["[email protected]"], subject: "Hi", text: "Hello" }
const first = await resend.emails.send(email, { idempotencyKey: "invite-1" })
const retry = await resend.emails.send(email, { idempotencyKey: "invite-1" })
// retry.data?.id === first.data?.id

const sent = await (await fetch(`${emulator.url}/__admin/[email protected]`)).json()
// sent.messages.length === 1
await emulator.close()

路线

认证是 Authorization: Bearer <key>; 任何关键作品; 无为 401 missing_api_key。 。 。 .

SDK出错映射. [email protected] 永远不要扔出: 一个非-2xx JSON身体 逐字回回作为 {data: null, error: {statusCode, name, message}}一个非JSON机构变成 {name: "application_error", message: "Internal server error. …"}; 已丢弃的连接 变成 {name: "application_error", message: "Unable to fetch data. The request could not be resolved."}。 。 。 . [email protected] 也读作 RESEND_BASE_URL 导入并返回 JSON 错误对象,但是其 客户端不捕捉非 JSON 机构或被丢弃的套接字( 那些拒绝) 。 也没有 idempotencyKey 选项; 发送 Idempotency-Key 抬头,作为 [email protected] 已经.

网络呼号

POST /__admin/inbound 存储电子邮件,然后发布到每个端点:

{"type": "email.received", "created_at": "…",
 "data": {"email_id": "…", "created_at": "…", "from": "…", "to": ["[email protected]"], "cc": [], "bcc": [],
          "subject": "…", "message_id": "<…>", "attachments": [{"id", "filename", "content_type", "content_disposition", "content_id"}]}}

和Resend一样 尸体上没有 text, (中文(简体) ), html, (中文(简体) ), headers 或下载 URL,所以是接收器 通过收发邮件的路线给它们水分. 过 "inline": true 包括他们 每个 发送由 Svix 方式签名 : svix-id, (中文(简体) ), svix-timestamp (墙钟,即使模拟器 时钟移动, svix-signature: v1,<base64 HMAC-SHA256(secret bytes, "id.ts.body")>编辑 正式 svix Webhook.verify 接受他们。 非-2xx 的答案被重审(立即,5 s, 5分30分2小时. GET /__admin/webhooks, (中文(简体) ), …/events, (中文(简体) ), …/flush, (中文(简体) ), …/:id/replay 财务报告和审定财务报表 PUT /__admin/webhook-endpoints (每个名称接收) 与合同.

管理员(超过标准合同)

--forward-to-inbox <url> 复制每个接受的发送( 不重放) 到 Mailosaur 模拟器 POST /__admin/ingest,在 同名空间名称,并等待最多2 s。 失败 收件箱从不失败发送; 计数为 /__admin/forwarding。将同样的密钥映射到 仿真器上的同名空间和一个工人通过Mailosaur SDK读取其转发的邮件.

错误预设( E)POST /__admin/faults {"preset": "<name>", "count"?: n}· ; GET /__admin/faults/presets: send_422 (单位:千美元){statusCode: 422, name: "validation_error", message}, (中文(简体) ), send_429 (单位:千美元)rate_limit_exceeded 与 retry-after 财务报告和审定财务报表 ratelimit-* 信头, send_500 (单位:千美元)internal_server_error, (中文(简体) ), non_json_500 (HTML 500页), network_drop (连接) 在接受之前死亡,所以没有储存, accepted_then_network_drop (发送被存储, 然后在任何响应字节之前连接会死;同样的键重放), receiving_500 (收到的电子邮件路线回答500), webhook_duplicate, (中文(简体) ), webhook_reorder, (中文(简体) ), webhook_drop。 。 。 .

命名空间

new Resend(key) 无法添加信头, 因此将 API 密钥映射到命名空间 : PUT /__admin/credentials {"credentials": {"<RESEND_API_KEY>": "<namespace>"}}此外 x-mockingbird-namespace,或一个 /__admin/ns/<name> 前缀在 RESEND_BASE_URL。 。 。 .

故意不模拟

• 交付本身:没有SMTP、弹出、投诉、打开或点击,没有 email.sent 编号 : email.delivered (原始内容存档于2018-10-21). webhoks. last_event 实值 delivered 一次(scheduled 与 scheduled_at,储存但永远不放火).
• 批次发送,模板,域名, API 密钥, 受众, 联系人和广播(我们的代码调用为无) .
• 附录 path 未获取 URL; 发送附件只保留元数据 .
• 费率限额,但 send_429。 。 。 .
• 偶能窗口:密钥永远不会过期(Resend keep them 24 h).

API 密码

部分 嘲笑鸟。 。 。 .