Bettermail 邮局

管理员登录。使用部署时配置的 API_TOKEN。

未设置 API_TOKEN 时,留空即可进入(仅建议本地调试)。

BettermailPost Office Admin
Swagger UI ↗ OpenAPI YAML ↗

概览

邮局运行状态与快速入口
加载中…

快速操作

域名

配置可收信域名,以及允许的最大子域名级数(0–9)

添加域名

级数 0 = user@domain;3 = user@a.b.c.domain。生成时不可超过此处上限。

域名状态最大子域级数备注操作

生成邮箱

在已配置域名上随机生成邮箱(含多级子域)

邮箱列表

已生成 / 自动创建的邮箱记录
地址子域级数邮件数最近收信操作

邮件

按邮箱查看列表与正文(默认不消费删除)

输入邮箱后加载
选择左侧邮件查看内容

API 说明

对接文档与常用示例
Swagger UI交互式 API 文档,可在线试调 中文 API 手册完整 Markdown 说明 OpenAPI YAML导入 Apifox / Postman HealthGET /health 健康检查

鉴权

管理接口使用 API_TOKEN(与本后台登录相同):

Authorization: Bearer <API_TOKEN>
# 或
X-API-Key: <API_TOKEN>

Worker 推送模式

POST_OFFICE_URL=https://你的邮局域名/v1/inbound
POST_OFFICE_TOKEN=<INBOUND_TOKEN 或 API_TOKEN>

常用接口

GET  /v1/config
GET  /v1/domains
POST /v1/domains                 {"name":"example.com","maxSubdomainLevels":3}
POST /v1/mailboxes/generate      {"domain":"example.com","subdomainLevels":2,"count":1}
GET  /v1/mails?to=a@b.com
GET  /v1/mails/{id}
GET  /mails?to=a@b.com           # 兼容:拉信即删
POST /v1/inbound                 # Worker 入站