电子邮件接口

目前我们还没有发布任何 API 包装器，但我们计划在不久的将来这样做。发送电子邮件至 api@forwardemail.net 如果您想在特定编程语言的 API 包装器发布时收到通知。同时，您可以在应用程序中使用这些推荐的 HTTP 请求库，或者简单地使用 卷曲 如下例所示。

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

所有端点都需要您的 API 密钥 设置为请求的“用户名”值 基本授权 标题（除了 别名联系人, 别名日历， 和 别名信箱 使用 生成的别名用户名和密码)..

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

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

[!TIP] 如果您收到 5xx 状态代码（这不应该发生），请联系我们 api@forwardemail.net 我们将帮助您立即解决您的问题。

我们的服务被翻译成超过 25 种不同的语言。所有 API 响应消息都将转换为检测到的发出 API 请求的用户的最后一个语言环境。您可以通过传递自定义来覆盖它 Accept-Language 标题。随意使用本页底部的语言下拉菜单尝试一下。

[!NOTE] 截至 2024 年 11 月 1 日，API 端点 列出域 和 列出域别名 将默认为 1000 每页最多结果数。如果您想尽早选择此行为，您可以通过 ?paginate=true 作为端点查询 URL 的附加查询字符串参数。

所有列出结果的 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 允许您以编程方式下载您帐户的日志。向此端点提交请求将处理您帐户的所有日志，并将它们作为附件通过电子邮件发送给您（压缩包 压缩的 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"

[!NOTE] 与其他 API 端点不同，这些端点需要 验证 “用户名”等于别名用户名，“密码”等于别名生成的密码作为基本授权标头。

[!警告] 此端点部分尚在开发中，预计将于 2024 年发布。在此期间，请使用我们网站导航中“应用程序”下拉菜单中的 IMAP 客户端。

[!NOTE] CardDAV 支持尚未提供，请关注 GitHub 上的讨论以获取更新.

列出联系人

GET /v1/contacts

即将推出

创建联系人

POST /v1/contacts

即将推出

检索联系人

GET /v1/contacts/:id

即将推出

更新联系方式

PUT /v1/contacts/:id

即将推出

删除联系人

DELETE /v1/contacts/:id

即将推出

[!NOTE] 与其他 API 端点不同，这些端点需要 验证 “用户名”等于别名用户名，“密码”等于别名生成的密码作为基本授权标头。

[!警告] 此端点部分尚在开发中，预计将于 2024 年发布。在此期间，请使用我们网站导航中“应用程序”下拉菜单中的 IMAP 客户端。

列出日历

GET /v1/calendars

即将推出

创建日历

POST /v1/calendars

即将推出

检索日历

GET /v1/calendars/:id

即将推出

更新日历

PUT /v1/calendars/:id

即将推出

删除日历

DELETE /v1/calendars/:id

即将推出

[!NOTE] 与其他 API 端点不同，这些端点需要 验证 “用户名”等于别名用户名，“密码”等于别名生成的密码作为基本授权标头。

[!警告] 此端点部分尚在开发中，预计将于 2024 年发布。在此期间，请使用我们网站导航中“应用程序”下拉菜单中的 IMAP 客户端。

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

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

列出并搜索消息

GET /v1/messages

即将推出

创建消息

[!NOTE] 这将 NOT 发送电子邮件——它只会将消息添加到您的邮箱文件夹（例如，这类似于 IMAP APPEND 命令）。如果您想发送电子邮件，请参阅 创建出站 SMTP 电子邮件 下面。创建出站 SMTP 电子邮件后，您可以使用此端点将其副本附加到别名的邮箱中以供存储。

POST /v1/messages

即将推出

检索消息

GET /v1/messages/:id

即将推出

更新消息

PUT /v1/messages/:id

即将推出

删除消息

DELETE /v1/messages:id

即将推出

[!TIP] 带有文件夹路径的文件夹端点 /v1/folders/:path 因为它们的端点可以与文件夹的 ID 互换 :id。这意味着您可以通过其 path 或者 id 价值。

[!警告] 此端点部分尚在开发中，预计将于 2024 年发布。在此期间，请使用我们网站导航中“应用程序”下拉菜单中的 IMAP 客户端。

列出文件夹

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、返回路径和 DMARC，以便使用您的域发送出站 SMTP。

获取出站 SMTP 电子邮件限制

这是一个简单的端点，它返回一个 JSON 对象，其中包含 count 和 limit 每个帐户每天发送的 SMTP 邮件数量。

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 电子邮件

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

DELETE /v1/emails/:id

示例请求：

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

[!TIP] 带有域名的域端点 /v1/domains/:domain_name 因为它们的端点可以与域的 ID 互换 :domain_id.这意味着您可以通过以下任一方式引用域 name 或者 id 价值。

列出域

[!NOTE] 截至 2024 年 11 月 1 日，API 端点 列出域 和 列出域别名 将默认为 1000 每页最多结果数。如果您想尽早选择此行为，您可以通过 ?paginate=true 作为端点查询 URL 的附加查询字符串参数。请参阅 分页 以获得更多洞察力。

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:

更新域

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

[!IMPORTANT] 如果受邀用户已经是邀请他们的管理员所属的任何其他域的接受成员，则它将自动接受邀请并且不会发送电子邮件。

删除域邀请

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:

生成别名密码

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

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:

列出域别名

[!NOTE] 截至 2024 年 11 月 1 日，API 端点 列出域 和 列出域别名 将默认为 1000 每页最多结果数。如果您想尽早选择此行为，您可以通过 ?paginate=true 作为端点查询 URL 的附加查询字符串参数。请参阅 分页 以获得更多洞察力。

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"