电子邮件 API

目前我们尚未发布任何 API 包装器，但计划在不久的将来发布。如果您希望在特定编程语言的 API 包装器发布时收到通知，请发送电子邮件至 api@forwardemail.net。目前，您可以在应用程序中使用这些推荐的 HTTP 请求库，或者像以下示例一样直接使用 卷曲。

当前 HTTP 基本 URI 路径为：https://api.forwardemail.net。

所有端点都要求将 API 密钥 设置为请求的 基本授权 标头的“用户名”值（别名联系人、别名日历 和 别名邮箱 除外，它们使用 生成的别名用户名和密码）。

别担心——如果您不确定这是什么，下面会为您提供示例。

如果发生任何错误，API 请求的响应主体将包含详细的错误消息。

我们的服务已翻译成超过 25 种不同的语言。所有 API 响应消息均会翻译为检测到的 API 请求用户的最新语言环境。您可以通过传递自定义 Accept-Language 标头来覆盖此设置。欢迎使用本页面底部的语言下拉菜单进行尝试。

所有列出结果的 API 端点都支持分页。

只需提供查询字符串属性 page（以及可选的 limit）。

属性 page 应为大于或等于 1 的数字。如果您提供的是 limit（也是一个数字），则最小值为 10，最大值为 50（除非另有说明）。

为了确定是否有更多结果可用，我们提供了这些 HTTP 响应标头（您可以解析它们以便以编程方式进行分页）：

示例请求：

curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

检索日志

我们的 API 允许您以编程方式下载您帐户的日志。向此端点提交请求后，系统会处理您帐户的所有日志，并在完成后以附件（Gzip 压缩的 CSV 电子表格文件）的形式通过电子邮件发送给您。

这允许您使用 计划任务 或使用我们的 Node.js 作业调度软件 Bree 创建后台作业，以便随时接收日志。请注意，此端点每天限制 10 个请求。

附件是 email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz 的小写形式，电子邮件本身包含已检索日志的简要摘要。您也可以随时从 我的账户 → 日志 下载日志

GET /v1/logs/download

示例请求：

curl https://api.forwardemail.net/v1/logs/download \
  -u API_TOKEN:

示例 Cron 作业（每天午夜）：

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

请注意，您可以使用 Crontab.guru 等服务来验证您的 cron 作业表达式语法。

示例 Cron 作业（每天午夜 并记录前一天的日志）：

对于 MacOS：

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date -v-1d -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

对于 Linux 和 Ubuntu：

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date --date "-1 days" -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

创建帐户

POST /v1/account

示例请求：

curl -X POST https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

检索帐户

GET /v1/account

示例请求：

curl https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

更新帐户

PUT /v1/account

示例请求：

curl -X PUT https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

列出联系人

GET /v1/contacts

即将推出

创建联系人

POST /v1/contacts

即将推出

检索联系人

GET /v1/contacts/:id

即将推出

更新联系人

PUT /v1/contacts/:id

即将推出

删除联系人

DELETE /v1/contacts/:id

即将推出

列出日历

GET /v1/calendars

即将推出

创建日历

POST /v1/calendars

即将推出

检索日历

GET /v1/calendars/:id

即将推出

更新日历

PUT /v1/calendars/:id

即将推出

删除日历

DELETE /v1/calendars/:id

即将推出

请确保您已遵循域名的设置说明。

这些说明可以在我们的常见问题解答部分 你们支持使用 IMAP 接收电子邮件吗？ 中找到。

列出并搜索消息

GET /v1/messages

即将推出

创建消息

POST /v1/messages

即将推出

检索消息

GET /v1/messages/:id

即将推出

更新消息

PUT /v1/messages/:id

即将推出

删除消息

DELETE /v1/messages:id

即将推出

列出文件夹

GET /v1/folders

即将推出

创建文件夹

POST /v1/folders

即将推出

检索文件夹

GET /v1/folders/:id

即将推出

更新文件夹

PUT /v1/folders/:id

即将推出

删除文件夹

DELETE /v1/folders/:id

即将推出

复制文件夹

POST /v1/folders/:id/copy

即将推出

请确保您已遵循域名的设置说明。

这些说明可在 我的账户 → 域名 → 设置 → 出站 SMTP 配置 找到。您需要确保已设置 DKIM、Return-Path 和 DMARC，以便使用您的域名发送出站 SMTP 邮件。

获取出站 SMTP 电子邮件限制

这是一个简单的端点，它返回一个 JSON 对象，其中包含每个帐户每天 SMTP 出站消息数量的 count 和 limit。

GET /v1/emails/limit

示例请求：

curl https://api.forwardemail.net/v1/emails/limit \
  -u API_TOKEN:

列出出站 SMTP 电子邮件

请注意，此端点不会返回电子邮件的 message、headers 或 rejectedErrors 的属性值。

要返回这些属性及其值，请使用带有电子邮件 ID 的 检索电子邮件 端点。

GET /v1/emails

示例请求：

curl https://api.forwardemail.net/v1/emails?limit=1 \
  -u API_TOKEN:

创建出站 SMTP 电子邮件

我们创建电子邮件的 API 灵感源自 Nodemailer 的消息选项配置，并充分利用了它。以下所有正文参数请遵循 Nodemailer 消息配置 的规范。

请注意，除了 envelope 和 dkim（因为我们会自动为您设置）之外，我们支持所有 Nodemailer 选项。出于安全考虑，我们会自动将 disableFileAccess 和 disableUrlAccess 选项设置为 true。

您应该将 raw 的单一选项与包含标题的原始完整电子邮件一起传递，或者传递下面的单独正文参数选项。

如果在邮件头中发现表情符号，此 API 端点会自动为您编码（例如，主题行 Subject: 🤓 Hello 会自动转换为 Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello）。我们的目标是打造一个对开发者极其友好且防伪的电子邮件 API。

POST /v1/emails

示例请求：

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

示例请求：

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

检索出站 SMTP 电子邮件

GET /v1/emails/:id

示例请求：

curl https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

删除出站 SMTP 电子邮件

当且仅当当前状态为 "pending"、"queued" 或 "deferred" 之一时，删除电子邮件会将状态设置为 "rejected"（并且随后不会在队列中处理该邮件）。我们可能会在电子邮件创建和/或发送 30 天后自动清除邮件，因此您应该在客户端、数据库或应用程序中保留一份已发送 SMTP 邮件的副本。如果需要，您可以在数据库中引用我们的电子邮件 ID 值，该值会从 创建电子邮件 和 检索电子邮件 端点返回。

DELETE /v1/emails/:id

示例请求：

curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

列出域

GET /v1/domains

示例请求：

curl https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

创建域

POST /v1/domains

示例请求：

curl -X POST https://api.forwardemail.net/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

检索域

GET /v1/domains/example.com

示例请求：

curl https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

验证域记录

GET /v1/domains/example.com/verify-records

示例请求：

curl https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

验证域 SMTP 记录

GET /v1/domains/example.com/verify-smtp

示例请求：

curl https://api.forwardemail.net/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

列出全域通用密码

GET /v1/domains/example.com/catch-all-passwords

示例请求：

curl https://api.forwardemail.net/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

创建全域通用密码

POST /v1/domains/example.com/catch-all-passwords

示例请求：

curl BASE_URL/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

移除全域通用密码

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

示例请求：

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

更新域

PUT /v1/domains/example.com

示例请求：

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

删除域

DELETE /v1/domains/:domain_name

示例请求：

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
  -u API_TOKEN:

接受域名邀请

GET /v1/domains/:domain_name/invites

示例请求：

curl https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

创建域名邀请

POST /v1/domains/example.com/invites

示例请求：

curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

移除域名邀请

DELETE /v1/domains/:domain_name/invites

示例请求：

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

更新域成员

PUT /v1/domains/example.com/members/:member_id

示例请求：

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

移除域成员

DELETE /v1/domains/:domain_name/members/:member_id

示例请求：

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

生成别名密码

请注意，如果您不通过电子邮件发送说明，则用户名和密码将以 { username: 'alias@yourdomain.com', password: 'some-generated-password' } 格式出现在成功请求的 JSON 响应正文中。

POST /v1/domains/example.com/aliases/:alias_id/generate-password

示例请求：

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

列出域别名

GET /v1/domains/example.com/aliases

示例请求：

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

创建新的域别名

POST /v1/domains/example.com/aliases

示例请求：

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

检索域别名

您可以通过 id 或 name 值检索域别名。

GET /v1/domains/:domain_name/aliases/:alias_id

示例请求：

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

GET /v1/domains/:domain_name/aliases/:alias_name

示例请求：

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

更新域别名

PUT /v1/domains/example.com/aliases/:alias_id

示例请求：

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

删除域别名

DELETE /v1/domains/:domain_name/aliases/:alias_id

示例请求：

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

即使在免费方案中，我们也允许您免费加密记录。隐私不应该只是一项功能，而应该融入产品的各个方面。应 隐私指南讨论 和 我们的 GitHub 问题 中的强烈要求，我们已添加此功能。

加密 TXT 记录

POST /v1/encrypt

示例请求：

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "input=user@gmail.com"