@ 模拟器/ 转发
以电子邮件发送,域管理,API密钥,受众,联系人,以及抓取消息的本地收件箱来重新发送电子邮件 API 模拟.
部分 模拟 ——为CI和无网络沙盒提供本地出入口替换服务.
安装
npm install @emulators/resend
终点
电子邮件
POST /emails——发送单个电子邮件POST /emails/batch发送最多100个电子邮件GET /emails—列表已发送电子邮件GET /emails/:id- 获取电子邮件POST /emails/:id/cancel——取消预定的电子邮件
目 录
POST /emails 财务报告和审定财务报表 POST /emails/batch 接受不区分大小写 Idempotency-Key 头曰. 密钥必须是1至256个字符并保留24小时. 重复使用相同的密钥和经验证的有效载荷的请求返回原始响应,而不创建另一个电子邮件或发送重复的webhooks. 使用不同有效载荷或端点返回的密钥 409 invalid_idempotent_request返回无效的密钥长度 400 invalid_idempotency_key. 请求不包含头部,保持正常的非本能行为.
收件人限制和发送尝试
设定 resend.allowlist 在种子配置中测试收件人拒绝 :
resend:
allowlist:
- [email protected]
- [email protected]
选择 allowlist 接受每个接收者; allowlist: [] 拒绝每个接收者。 每一个地址 to, (中文(简体) ), cc,以及 bcc 必须列出。 匹配忽略了周围的白空和字母大小写;条目是单个地址,没有通配符或域匹配. 这是一个本地测试控制,独立于Resend的域验证和账户限制.
拒绝发送返回 403 validation_error 命名拒绝的地址并配置允许列表。 没有创建电子邮件 ID 、 电子邮件记录、 idempotency 记录或 Webhook 。 如果任何接收者被拒绝,则批次全部被拒绝。 重试一个被拒绝的请求,即使使用同样的同能键,也会产生新的尝试. 重放一个被接受的同位素请求返回其原始响应,即使允许列表后来有所改变.
核验后发送一个记录 resend.send_attempts 存储收藏,包括拒绝批次的电子邮件。 每张记录中包含 from, (中文(简体) ), to, (中文(简体) ), cc, (中文(简体) ), bcc, (中文(简体) ), subject, (中文(简体) ), idempotency_key (或 null)和商店的 id, (中文(简体) ), created_at,以及 updated_at。信件机构不复制到尝试中。 错误的请求, 无效或相冲突的等效键, 等效重放不附加尝试 .
读取尝试 getResendStore(store).sendAttempts.all() 从 @emulators/resend或检查持续状态。 共享适配器快照使用密钥 resend:resend.send_attempts尝试和接收者的限制在保存状态恢复后继续存在,包括被拒绝的发送。 尝试没有额外的Resend API 端点 。 被拒绝的发送没有电子邮件;从未发生的发送也没有.
域数
POST /domains——创建域GET /domains列表域GET /domains/:id——获得域名DELETE /domains/:id— 删除域POST /domains/:id/verify——触发域验证
API 密钥
POST /api-keys——创建 API 密钥GET /api-keys— 列表 API 密钥DELETE /api-keys/:id— 删除 API 密钥
观众联系人( C)
POST /audiences——创造观众GET /audiences——列表受众DELETE /audiences/:id- 删除听众POST /audiences/:audience_id/contacts- 增加联系人GET /audiences/:audience_id/contacts——列表联系人DELETE /audiences/:audience_id/contacts/:id- 删除联系人
收件箱
GET /inbox——列表收录的电子邮件GET /inbox/:id——浏览已抓取的电子邮件
种子配置
resend:
domains:
- name: example.com
api_keys:
- name: default