调度和操作

site-search,starlight-theme-select{display:none!important}

导航

指南

方法API

排队一封信

从 GET /v1/mailboxes. 接收 ID 盒子为一次提交创建一个唯一的 Idempotency-Key 并保存直至最终结果。对于网络重放，请使用相同的密钥和相同的正文。

HTTP 202 返回操作对象，而不是交付确认。 Field id contains ID operations.民意调查 GET /v1/operations/{operation_id}.

POST /v1/mailboxes/42/send
Idempotency-Key: message-20261019-0001
Content-Type: application/json

{"to":["[email protected]"],"subject":"Hello","text":"A message from Adapt Mail"}

如何理解结果

queued: 这封信正在等待发送。
running: 发送正在进行中。
succeeded: 邮件服务器接受了提交。检查每个收件人的结果。
failed: 发送失败。原因在 error. 中给出
cancelled: 发货已取消。
uncertain: 无法确认发送结果。请在重试之前检查操作和您的发送文件夹。

成功发送后，result 字段包含 accepted_recipients - 接受的收件人、rejected_recipients - 拒绝的收件人和 sent_saved - 在发送中保存副本的结果。邮件服务器接受信件并不保证信件能够送达收件人的收件箱。

要取消挂起的发送，请运行 POST /v1/operations/{operation_id}/cancel. /retry 方法不会重新发送电子邮件。

回复、转发和延迟发送

要回复，请在 reply_to_message_id 中包含原始电子邮件的 message_id 并将其转发至 references. 在 to 中，输入 reply_to 的回复地址或发件人地址。要回复所有人，请将其他参与者添加到 to 和 cc，但不包括您自己的地址。

要转发附件，请传递 forward_message 以及 folder、uidvalidity 和 uid. 对于上传的文件，请使用 file_ids. 附件总大小限制为 25 MiB。

send_at 指定时区，存储在 UTC 中；一年内可延期发货。限制是在实际发送时检查的，而不是在队列创建时检查的。