Temp Mail API Documentation - Boomlify

Complete API reference for temporary email service integration

POST`/api/v1/emails/create`

创建一个新的临时邮箱地址现在支持可选的 custom_username 参数来创建具有个性化地址的邮箱。

Parameters:

custom_username (query, optional): 邮箱地址的可选自定义用户名。可以包含字母、数字、点、连字符和下划线。必须是 3-30 个字符。如果省略，将生成随机用户名。 - Example: john.doe
time (query, optional): 过期时间 - Example: permanent
domain (query, optional): 邮箱地址的可选自定义域名。必须是您账户中已验证的域名（使用 custom_domains 端点进行验证）。如果未指定，将使用随机公共域名。 - Example: mail.yourdomain.com
create_as_dashboard (query, optional): 💎 高级功能 - 设置为 "true" 以创建存储在数据库中的仪表板样式邮箱，具有固定的 2 个月过期时间，而不是基于时间的 API 邮箱。省略或设置为 "false" 用于基于时间的邮箱（默认）。仪表板邮箱花费 15 积分。免费用户将收到 403 错误。 - Example: true

Error Responses:

INVALID_USERNAME (400): 自定义用户名验证失败。必须仅包含有效字符的 3-30 个字符。
EMAIL_IN_USE (409): 自定义用户名已被占用。请选择不同的用户名。
DOMAIN_NOT_FOUND (400): 指定的域名不存在或未验证。请先在您的账户中验证它。
DOMAIN_NOT_VERIFIED (400): 域名存在但尚未验证。请先完成域名验证。
DAILY_LIMIT_EXCEEDED (429): 您已达到此类邮箱的每日限制

Auth Required: Yes | Rate Limited: Yes | Group: Quickstart

GET`/api/v1/emails`

列出您所有的活动临时邮箱

Parameters:

include_expired (query, optional): 包括已过期的邮箱 - Example: true
permanent_only (query, optional): 仅显示您保存的永久收件箱。每次请求花费 2 积分。 - Example: true
include_permanent (query, optional): 包括您保存的永久收件箱以及最近的收件箱。每次请求花费 2 积分。 - Example: true
limit (query, optional): 返回的邮箱数量 - Example: 50

Error Responses:

INSUFFICIENT_CREDITS (402): 尝试列出已保存的永久收件箱但账户积分不足时返回。

Auth Required: Yes | Rate Limited: No | Group: Emails

GET`/api/v1/emails/{id}`

获取特定邮箱的详细信息

Parameters:

id (path, required): 邮箱 ID - Example: 550e8400-e29b-41d4-a716-446655440000

Error Responses:

EMAIL_NOT_FOUND (404): 邮箱 ID 无效或邮箱已过期

Auth Required: Yes | Rate Limited: No | Group: Emails

GET`/api/v1/emails/{id}/messages`

获取特定邮箱的消息

Parameters:

id (path, required): 邮箱 ID - Example: 550e8400-e29b-41d4-a716-446655440000
limit (query, optional): 返回的消息数量 - Example: 50
offset (query, optional): 跳过的消息数量 - Example: 0

Error Responses:

EMAIL_NOT_FOUND (404): 邮箱 ID 无效或邮箱已过期
INVALID_LIMIT (400): 限制参数超出有效范围

Auth Required: Yes | Rate Limited: No | Group: Emails

DELETE`/api/v1/emails/{id}`

通过 ID 删除邮箱。支持基于时间的 API 邮箱（内存中，立即删除）和仪表板邮箱（数据库持久化，立即删除）。如果邮箱未找到或已删除，返回 404。

Parameters:

id (path, required): 邮箱 ID（UUID 格式）。可以是基于时间的 API 邮箱 ID 或使用 create_as_dashboard=true 创建的仪表板邮箱 ID - Example: 550e8400-e29b-41d4-a716-446655440000

Error Responses:

EMAIL_NOT_FOUND (404): 邮箱不存在或已被删除

Auth Required: Yes | Rate Limited: No | Group: Emails

GET`/api/v1/emails`

💎 高级功能 - 列出所有邮箱，包括仪表板创建的邮箱。此端点将 API 创建的邮箱与您的仪表板邮箱合并为单个响应。每次请求花费 2 积分。需要基础套餐或更高版本。

Parameters:

include_dashboard (query, required): 必须设置为 "true" 以访问仪表板邮箱。这将启用高级功能并收取 2 积分。 - Example: true
include_expired (query, optional): 在响应中包括已过期的邮箱（API 和仪表板邮箱） - Example: false
limit (query, optional): 返回的最大邮箱数量（最多：100） - Example: 50

Error Responses:

TIER_RESTRICTED (403): 这是高级功能。免费用户无法通过 API 访问仪表板邮箱。
INSUFFICIENT_CREDITS (402): 此操作花费 2 积分。请在您的账户中添加更多积分。

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/emails/{id}`

💎 高级功能 - 获取特定仪表板邮箱的详细信息。如果邮箱在 API 存储中未找到，它将搜索您的仪表板邮箱。每次请求花费 1 积分。需要基础套餐或更高版本。

Parameters:

id (path, required): 仪表板邮箱 ID（UUID 格式）- 从您的仪表板或 list-dashboard-emails 端点复制此 ID - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): 必须是 "true" 以搜索仪表板邮箱。收取 1 积分。 - Example: true

Error Responses:

TIER_RESTRICTED (403): 仪表板邮箱访问需要付费套餐
INSUFFICIENT_CREDITS (402): 此操作花费 1 积分
EMAIL_NOT_FOUND (404): 请求的邮箱未找到或已过期

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/emails/{id}/messages`

💎 高级功能 - 检索仪表板邮箱的所有接收消息，支持分页。使用缓存以实现快速响应时间。每次请求花费 1 积分。需要基础套餐或更高版本。

Parameters:

id (path, required): 仪表板邮箱 ID - 您要获取消息的邮箱的 UUID - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): 必须是 "true" 以访问仪表板邮箱消息。收取 1 积分。 - Example: true
limit (query, optional): 每页返回的最大消息数量（最多：100） - Example: 20
offset (query, optional): 分页跳过的消息数量（例如，offset=20 和 limit=20 获取第 2 页） - Example: 0

Error Responses:

TIER_RESTRICTED (403): 仪表板邮箱访问需要付费套餐
INSUFFICIENT_CREDITS (402): 此操作花费 1 积分
EMAIL_NOT_FOUND (404): 请求的邮箱未找到或已过期

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/emails/{id}/telegram-forwarding`

Premium Feature - Get Telegram forwarding status for a specific owned mailbox. Supports dashboard mailboxes and permanent API mailboxes. Ownership is checked through the existing cached mailbox lookup paths, and forwarding state is returned from the forwarding cache. Costs 2 credits per request. Requires Basic plan or higher.

Parameters:

id (path, required): Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding status you want to inspect - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Must be set to "true" to access Telegram forwarding mailbox status. Charges 2 credits. - Example: true

Error Responses:

TIER_RESTRICTED (403): This is a premium feature. Free tier users cannot access dashboard email forwarding via API.
INSUFFICIENT_CREDITS (402): This operation costs 2 credits. Please add more credits to your account.
EMAIL_NOT_FOUND (404): The requested mailbox was not found, is unsupported, or has expired

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

POST`/api/v1/emails/{id}/telegram-forwarding`

Premium Feature - Enable or disable Telegram forwarding for an owned mailbox. Supports dashboard mailboxes and permanent API mailboxes, while reusing the existing forwarding cache and write-through persistence path. Costs 2 credits per request. Requires Basic plan or higher and an active Telegram binding.

Parameters:

id (path, required): Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding you want to update - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Must be set to "true" to update Telegram mailbox forwarding. Charges 2 credits. - Example: true
is_enabled (body, required): Boolean body field. Set true to enable forwarding or false to disable forwarding. - Example: true

Error Responses:

TIER_RESTRICTED (403): This is a premium feature. Free tier users cannot update dashboard email forwarding via API.
INSUFFICIENT_CREDITS (402): This operation costs 2 credits. Please add more credits to your account.
NO_TELEGRAM_BINDING (400): Forwarding cannot be enabled until the account has an active verified Telegram binding.
FORWARDING_LIMIT_EXCEEDED (403): The user has reached the plan limit for active Telegram forwardings.
EMAIL_NOT_FOUND (404): The requested mailbox was not found, is unsupported, or has expired

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

POST`/api/v1/emails/telegram-forwarding/bulk-enable`

Premium Feature - Bulk enable Telegram forwarding for multiple owned mailboxes in one API request. Supports dashboard mailboxes and permanent API mailboxes, reuses the existing per-email forwarding enable flow, and respects the active-forwarding limit. Costs 2 credits per request. Requires Basic plan or higher and an active Telegram binding.

Parameters:

include_dashboard (query, required): Must be set to "true" to bulk enable Telegram mailbox forwarding. Charges 2 credits. - Example: true
email_ids (body, required): Body field containing a non-empty array of owned mailbox IDs. In the test form, you can enter a single mailbox ID or a JSON array. - Example: ["550e8400-e29b-41d4-a716-446655440000"]

Error Responses:

TIER_RESTRICTED (403): This is a premium feature. Free tier users cannot bulk enable dashboard email forwarding via API.
INSUFFICIENT_CREDITS (402): This operation costs 2 credits total per bulk request.
NO_TELEGRAM_BINDING (400): Forwarding cannot be enabled until the account has an active verified Telegram binding.
FORWARDING_LIMIT_EXCEEDED (403): The user has reached the plan limit for active Telegram forwardings.
EMAIL_NOT_FOUND (404): No matching forwardable mailboxes were found.

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

POST`/api/v1/emails/create`

💎 高级功能 - 创建具有可选自定义用户名的新邮箱。仪表板邮箱（create_as_dashboard=true）存储在数据库中，具有固定的 2 个月过期时间，花费 15 积分。基于时间的 API 邮箱支持自定义时间选项（10min, 1hour, 1day, permanent）。两者都支持 custom_username。需要基础套餐或更高版本。

Parameters:

create_as_dashboard (query, optional): 设置为 "true" 以创建存储在数据库中的仪表板样式邮箱，具有固定的 2 个月过期时间。如果省略，则在内存中创建基于时间的 API 邮箱。两者都支持 custom_username。 - Example: true
custom_username (query, optional): 邮箱地址的可选自定义用户名。可以包含字母、数字、点、连字符和下划线。必须是 3-30 个字符。如果省略，将生成随机用户名。 - Example: john.doe
domain (query, optional): 邮箱地址的可选自定义域名。如果未指定，将使用随机公共域名。 - Example: mail.yourdomain.com

Error Responses:

TIER_RESTRICTED (403): 仪表板邮箱创建需要付费套餐
INSUFFICIENT_CREDITS (402): 此操作花费 15 积分
INVALID_USERNAME (400): 自定义用户名验证失败。必须仅包含有效字符的 3-30 个字符。
EMAIL_IN_USE (409): 自定义用户名已被占用。请选择不同的用户名。
INVALID_TIME_PARAMETER (400): 时间必须是以下之一：10min, 1hour, 1day, permanent

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/account/usage`

获取您的 API 使用统计信息

Error Responses:

UNAUTHORIZED (401): API 密钥是必需的且必须有效

Auth Required: Yes | Rate Limited: No | Group: Account

GET`/api/v1/account/info`

获取您的账户信息

Error Responses:

UNAUTHORIZED (401): API 密钥是必需的且必须有效

Auth Required: Yes | Rate Limited: No | Group: Account

GET`/api/v1/account/credits`

获取详细的积分余额和使用信息

Error Responses:

UNAUTHORIZED (401): API 密钥是必需的且必须有效

Auth Required: Yes | Rate Limited: No | Group: Account

临时邮箱 API 文档与测试中心

在同一页面阅读文档、测试接口、复制代码。

基础 URL：

https://v1.boomlify.com

快速入门

邮箱

💎 Dashboard API (Premium)

账户

POST /api/v1/emails/create

创建一个新的临时邮箱地址现在支持可选的 custom_username 参数来创建具有个性化地址的邮箱。

需要认证有速率限制

文档

参数

查询

custom_username

邮箱地址的可选自定义用户名。可以包含字母、数字、点、连字符和下划线。必须是 3-30 个字符。如果省略，将生成随机用户名。

示例： john.doe

⚠️ ⚠️ 必须是 3-30 个字符。不能以特殊字符开头/结尾。必须唯一。如果已被占用，返回 409。

查询

time

过期时间

示例： permanent

⚠️ 必须是以下之一：10min, 1hour, 1day, permanent

查询

domain

邮箱地址的可选自定义域名。必须是您账户中已验证的域名（使用 custom_domains 端点进行验证）。如果未指定，将使用随机公共域名。

示例： mail.yourdomain.com

⚠️ ⚠️ 必须是已验证的自定义域名或公共域名。如果不可用，返回 400。

查询

create_as_dashboard

💎 高级功能 - 设置为 "true" 以创建存储在数据库中的仪表板样式邮箱，具有固定的 2 个月过期时间，而不是基于时间的 API 邮箱。省略或设置为 "false" 用于基于时间的邮箱（默认）。仪表板邮箱花费 15 积分。免费用户将收到 403 错误。

示例： true

⚠️ ⚠️ 必须是 "true" 或省略。仪表板邮箱需要基础套餐或更高版本。固定 2 个月过期（忽略时间参数）。

错误示例

400

INVALID_USERNAME

用户名必须至少 3 个字符

自定义用户名验证失败。必须仅包含有效字符的 3-30 个字符。

409

EMAIL_IN_USE

邮箱地址 "[email protected]" 已被使用

自定义用户名已被占用。请选择不同的用户名。

400

DOMAIN_NOT_FOUND

域名 "custom.domain" 不可用。它必须是您账户中已验证的自定义域名或公共域名。

指定的域名不存在或未验证。请先在您的账户中验证它。

400

DOMAIN_NOT_VERIFIED

自定义域名 "custom.domain" 未验证。当前状态：待处理

域名存在但尚未验证。请先完成域名验证。

429

DAILY_LIMIT_EXCEEDED

1小时邮箱的每日限制已超出

您已达到此类邮箱的每日限制

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

文档

参数

查询

include_expired

包括已过期的邮箱

示例： true

⚠️ 必须是 "true" 或 "false"

查询

permanent_only

仅显示您保存的永久收件箱。每次请求花费 2 积分。

示例： true

⚠️ 必须是 "true" 或 "false"

查询

include_permanent

包括您保存的永久收件箱以及最近的收件箱。每次请求花费 2 积分。

示例： true

⚠️ 必须是 "true" 或 "false"

查询

limit

返回的邮箱数量

示例： 50

⚠️ 最多 100 个邮箱

错误示例

402

INSUFFICIENT_CREDITS

添加积分以列出永久收件箱。

尝试列出已保存的永久收件箱但账户积分不足时返回。

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

文档

参数

路径必需

邮箱 ID

示例： 550e8400-e29b-41d4-a716-446655440000

⚠️ 必须是有效的 UUID

错误示例

404

EMAIL_NOT_FOUND

请求的邮箱未找到或已过期

邮箱 ID 无效或邮箱已过期

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

文档

参数

路径必需

邮箱 ID

示例： 550e8400-e29b-41d4-a716-446655440000

⚠️ 必须是有效的 UUID

查询

limit

返回的消息数量

示例： 50

⚠️ 最多 100 条消息

查询

offset

跳过的消息数量

示例： 0

⚠️ 必须是非负整数

错误示例

404

EMAIL_NOT_FOUND

请求的邮箱未找到或已过期

邮箱 ID 无效或邮箱已过期

400

INVALID_LIMIT

限制必须在 1 到 100 之间

限制参数超出有效范围

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

文档

参数

路径必需

邮箱 ID（UUID 格式）。可以是基于时间的 API 邮箱 ID 或使用 create_as_dashboard=true 创建的仪表板邮箱 ID

示例： 550e8400-e29b-41d4-a716-446655440000

⚠️ 必须是有效的 UUID

错误示例

404

EMAIL_NOT_FOUND

请求的邮箱未找到或已过期

邮箱不存在或已被删除

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

文档

参数

查询必需

include_dashboard

必须设置为 "true" 以访问仪表板邮箱。这将启用高级功能并收取 2 积分。

示例： true

⚠️ 必须是 "true" - 免费用户将收到 403 错误

查询

include_expired

在响应中包括已过期的邮箱（API 和仪表板邮箱）

示例： false

查询

limit

返回的最大邮箱数量（最多：100）

示例： 50

⚠️ 必须在 1 到 100 之间

错误示例

403

TIER_RESTRICTED

仪表板邮箱访问需要付费套餐（基础版或更高版本）

这是高级功能。免费用户无法通过 API 访问仪表板邮箱。

402

INSUFFICIENT_CREDITS

列出仪表板邮箱需要 2 积分

此操作花费 2 积分。请在您的账户中添加更多积分。

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

文档

参数

路径必需

仪表板邮箱 ID（UUID 格式）- 从您的仪表板或 list-dashboard-emails 端点复制此 ID

示例： 550e8400-e29b-41d4-a716-446655440000

⚠️ 必须是来自您仪表板邮箱的有效 UUID

查询必需

include_dashboard

必须是 "true" 以搜索仪表板邮箱。收取 1 积分。

示例： true

错误示例

403

TIER_RESTRICTED

高级功能

仪表板邮箱访问需要付费套餐

402

INSUFFICIENT_CREDITS

访问仪表板邮箱需要 1 积分

此操作花费 1 积分

404

EMAIL_NOT_FOUND

未找到邮箱

请求的邮箱未找到或已过期

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

文档

参数

路径必需

仪表板邮箱 ID - 您要获取消息的邮箱的 UUID

示例： 550e8400-e29b-41d4-a716-446655440000

⚠️ 必须是来自您仪表板邮箱的有效 UUID

查询必需

include_dashboard

必须是 "true" 以访问仪表板邮箱消息。收取 1 积分。

示例： true

查询

limit

每页返回的最大消息数量（最多：100）

示例： 20

⚠️ 必须在 1 到 100 之间

查询

offset

分页跳过的消息数量（例如，offset=20 和 limit=20 获取第 2 页）

示例： 0

⚠️ 必须是非负整数

错误示例

403

TIER_RESTRICTED

高级功能

仪表板邮箱访问需要付费套餐

402

INSUFFICIENT_CREDITS

访问仪表板邮箱消息需要 1 积分

此操作花费 1 积分

404

EMAIL_NOT_FOUND

未找到邮箱

请求的邮箱未找到或已过期

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

文档

参数

路径必需

Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding status you want to inspect

示例： 550e8400-e29b-41d4-a716-446655440000

⚠️ Must be an owned dashboard mailbox ID or permanent API mailbox ID

查询必需

include_dashboard

Must be set to "true" to access Telegram forwarding mailbox status. Charges 2 credits.

示例： true

⚠️ Must be "true" - Free tier users will receive a 403 error

错误示例

403

TIER_RESTRICTED

Dashboard email access requires a paid plan (Basic or higher)

This is a premium feature. Free tier users cannot access dashboard email forwarding via API.

402

INSUFFICIENT_CREDITS

Need 2 credits to access dashboard email Telegram forwarding status

This operation costs 2 credits. Please add more credits to your account.

404

EMAIL_NOT_FOUND

Email not found

The requested mailbox was not found, is unsupported, or has expired

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

文档

参数

路径必需

Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding you want to update

示例： 550e8400-e29b-41d4-a716-446655440000

⚠️ Must be an owned dashboard mailbox ID or permanent API mailbox ID

查询必需

include_dashboard

Must be set to "true" to update Telegram mailbox forwarding. Charges 2 credits.

示例： true

⚠️ Must be "true" - Free tier users will receive a 403 error

正文必需

is_enabled

Boolean body field. Set true to enable forwarding or false to disable forwarding.

示例： true

⚠️ Must be a boolean value

错误示例

403

TIER_RESTRICTED

Dashboard email access requires a paid plan (Basic or higher)

This is a premium feature. Free tier users cannot update dashboard email forwarding via API.

402

INSUFFICIENT_CREDITS

Need 2 credits to update dashboard email Telegram forwarding

This operation costs 2 credits. Please add more credits to your account.

400

NO_TELEGRAM_BINDING

No active Telegram binding found. Please bind your Telegram account first.

Forwarding cannot be enabled until the account has an active verified Telegram binding.

403

FORWARDING_LIMIT_EXCEEDED

Forwarding limit exceeded

The user has reached the plan limit for active Telegram forwardings.

404

EMAIL_NOT_FOUND

Email not found

The requested mailbox was not found, is unsupported, or has expired

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

文档

参数

查询必需

include_dashboard

Must be set to "true" to bulk enable Telegram mailbox forwarding. Charges 2 credits.

示例： true

⚠️ Must be "true" - Free tier users will receive a 403 error

正文必需

email_ids

Body field containing a non-empty array of owned mailbox IDs. In the test form, you can enter a single mailbox ID or a JSON array.

示例： ["550e8400-e29b-41d4-a716-446655440000"]

⚠️ Must resolve to a non-empty array of owned dashboard mailbox IDs or permanent API mailbox IDs. The bulk limit is 150 IDs per request.

错误示例

403

TIER_RESTRICTED

Dashboard email access requires a paid plan (Basic or higher)

This is a premium feature. Free tier users cannot bulk enable dashboard email forwarding via API.

402

INSUFFICIENT_CREDITS

Need 2 credits to bulk enable dashboard email Telegram forwarding

This operation costs 2 credits total per bulk request.

400

NO_TELEGRAM_BINDING

No active Telegram binding found. Please bind your Telegram account first.

Forwarding cannot be enabled until the account has an active verified Telegram binding.

403

FORWARDING_LIMIT_EXCEEDED

Forwarding limit exceeded

The user has reached the plan limit for active Telegram forwardings.

404

EMAIL_NOT_FOUND

Email not found

No matching forwardable mailboxes were found.

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

文档

参数

查询

create_as_dashboard

设置为 "true" 以创建存储在数据库中的仪表板样式邮箱，具有固定的 2 个月过期时间。如果省略，则在内存中创建基于时间的 API 邮箱。两者都支持 custom_username。

示例： true

⚠️ ⚠️ 仪表板邮箱花费 15 积分。固定 2 个月过期（无时间参数）。免费用户将收到 403 错误。省略此参数以创建具有自定义时间选项的基于时间的 API 邮箱。

查询

custom_username

邮箱地址的可选自定义用户名。可以包含字母、数字、点、连字符和下划线。必须是 3-30 个字符。如果省略，将生成随机用户名。

示例： john.doe

⚠️ ⚠️ 必须是 3-30 个字符。不能以特殊字符开头/结尾。必须在您的所有邮箱中唯一。如果已被占用，返回 409 冲突。

查询

domain

邮箱地址的可选自定义域名。如果未指定，将使用随机公共域名。

示例： mail.yourdomain.com

⚠️ 必须是您账户中已验证的域名

错误示例

403

TIER_RESTRICTED

高级功能

仪表板邮箱创建需要付费套餐

402

INSUFFICIENT_CREDITS

创建仪表板邮箱需要 15 积分

此操作花费 15 积分

400

INVALID_USERNAME

用户名必须至少 3 个字符

自定义用户名验证失败。必须仅包含有效字符的 3-30 个字符。

409

EMAIL_IN_USE

邮箱地址 "[email protected]" 已被使用

自定义用户名已被占用。请选择不同的用户名。

400

INVALID_TIME_PARAMETER

无效的时间参数

时间必须是以下之一：10min, 1hour, 1day, permanent

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

文档

错误示例

401

UNAUTHORIZED

API 密钥无效或缺失

API 密钥是必需的且必须有效

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

文档

错误示例

401

UNAUTHORIZED

API 密钥无效或缺失

API 密钥是必需的且必须有效

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

文档

错误示例

401

UNAUTHORIZED

API 密钥无效或缺失

API 密钥是必需的且必须有效

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

速率限制：60 RPMAPI 中心

测试 API

临时邮箱 API 文档与测试中心

在同一页面阅读文档、测试接口、复制代​​码。

POST /api/v1/emails/create

文档

参数

错误示例

请求示例

代码片段

在同一页面阅读文档、测试接口、复制代码。