查看邮件 API

通过 邮件 API 查看邮件

这是一个 python 的例子，使用 requests 库查看邮件。

limit = 10
offset = 0
res = requests.get(
    f"https://<你的worker地址>/api/mails?limit={limit}&offset={offset}",
    headers={
        "Authorization": f"Bearer {你的JWT密码}",
        # "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
        "Content-Type": "application/json"
    }
)

注意：/api/mails 按设计返回的是原始 RFC822 数据（如 source/raw），不保证直接包含 subject、text、html 等已解析字段。若要直接读取正文，请在客户端侧解析 raw（例如 mail-parser-wasm、postal-mime）。

admin 邮件 API

支持 address 过滤

import requests

url = "https://<你的worker地址>/admin/mails"

querystring = {
    "limit":"20",
    "offset":"0",
    # address 为可选参数
    "address":"[email protected]"
}

headers = {
        "x-admin-auth": "<你的Admin密码>",
        # "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
    }

response = requests.get(url, headers=headers, params=querystring)

print(response.json())

注意：/admin/mails 与 /api/mails 一致，返回的是邮件数据库中的 raw MIME 内容；如需正文/主题等可读字段，请在客户端自行解析 raw。

注意：后端 API 已移除关键词过滤功能。如需按内容过滤邮件，请使用前端界面的过滤输入框，该功能可过滤当前显示的页面。

邮件已读状态 API

启用 ENABLE_MAIL_READ_STATUS 并升级数据库后可使用。历史邮件的 is_unread 为 NULL，视为已读；新邮件为 1。用户在网页邮件列表中点击未读邮件后会将其设为已读，也可以在邮件详情中手动切换状态；刷新页面不会自动标记：

• PATCH /api/mails/:id/read：设置当前地址下单封邮件的状态，请求体为 { "isUnread": true }（未读）或 { "isUnread": false }（已读）

admin 获取单封邮件 API

无需邮箱 JWT，通过邮件 ID 获取单封邮件，并使用 x-admin-auth 认证。 返回结构与 /admin/mails 中的单条记录一致：gzip 压缩的原始邮件会解压到 raw，响应不包含 raw_blob。

import requests

mail_id = 1
url = f"https://<你的worker地址>/admin/mails/{mail_id}"

headers = {
        "x-admin-auth": "<你的Admin密码>",
        # "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
    }

response = requests.get(url, headers=headers)

print(response.json())

admin 删除邮件 API

通过邮件 ID 删除单封邮件。

import requests

mail_id = 1
url = f"https://<你的worker地址>/admin/mails/{mail_id}"

headers = {
        "x-admin-auth": "<你的Admin密码>",
        # "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
    }

response = requests.delete(url, headers=headers)

print(response.json())

admin 删除邮箱地址 API

通过邮箱地址 ID 删除邮箱地址（同时删除该地址关联的邮件、发件权限和用户绑定）。

import requests

address_id = 1
url = f"https://<你的worker地址>/admin/delete_address/{address_id}"

headers = {
        "x-admin-auth": "<你的Admin密码>",
        # "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
    }

response = requests.delete(url, headers=headers)

print(response.json())

admin 清空收件箱 API

通过邮箱地址 ID 清空该地址的所有收件。

import requests

address_id = 1
url = f"https://<你的worker地址>/admin/clear_inbox/{address_id}"

headers = {
        "x-admin-auth": "<你的Admin密码>",
        # "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
    }

response = requests.delete(url, headers=headers)

print(response.json())

admin 清空发件箱 API

通过邮箱地址 ID 清空该地址的所有发件。

import requests

address_id = 1
url = f"https://<你的worker地址>/admin/clear_sent_items/{address_id}"

headers = {
        "x-admin-auth": "<你的Admin密码>",
        # "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
    }

response = requests.delete(url, headers=headers)

print(response.json())

user 邮件 API

注意：用户 JWT vs 地址 JWT

这些接口使用用户 JWT（注册后通过 /user_api/login 获得），使用 x-user-token header。绑定邮箱时还需要同时提供地址 JWT。

请勿与地址 JWT 混淆：

• 地址 JWT 使用 Authorization: Bearer <jwt> 访问 /api/* 接口
• 用户 JWT 使用 x-user-token: <jwt> 访问 /user_api/* 接口

绑定邮箱到用户账号

这里的“绑定”是把已有邮箱关联到当前登录的用户账号，之后可在用户中心管理；Telegram 绑定请参考 Telegram Bot。

POST /user_api/bind_address 必须同时携带两个凭据：

请求头	内容
x-user-token	当前用户账号的 JWT，通过 POST /user_api/login 的响应字段 jwt 获取
Authorization	Bearer <地址JWT>，使用创建邮箱返回的 jwt 或邮箱登录后的地址 JWT

无需请求体；用户和邮箱身份分别从这两个 JWT 读取，不接受通过请求体指定 user_id、address_id 或邮箱地址。若站点设置了访问密码，还需携带 x-custom-auth。

import requests

response = requests.post(
    "https://<你的worker地址>/user_api/bind_address",
    headers={
        "x-user-token": "<你的用户JWT Token>",
        "Authorization": "Bearer <你的地址JWT>",
        # "x-custom-auth": "<你的网站密码>",
    },
)
print(response.json())  # {"success": True}

成功返回 {"success": true}；重复绑定到同一用户也返回成功。邮箱已绑定其他用户或已达到该用户可绑定邮箱数量上限时返回 400。

用户绑定地址列表

GET /user_api/bind_address 使用服务端分页，支持以下查询参数：

未携带分页参数时返回默认第一页，不支持一次获取全部绑定地址。

参数	默认值	说明
limit	20	每页数量，范围为 1–100
offset	0	分页偏移量
query	空	可选，按邮箱地址关键字筛选当前用户已绑定的地址；最长 100 个字符，不可包含 % 或 _，非法查询返回 400

响应中的 results 仅包含当前页。仅 offset=0 时查询筛选后的总数，后续页面的 count 为 0，客户端应保留第一页返回的总数。

import requests

url = "https://<你的worker地址>/user_api/bind_address"
headers = {
    "x-user-token": "<你的用户JWT Token>",
}
querystring = {
    "limit": "20",
    "offset": "0",
}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())

获取已绑定邮箱的地址 JWT

GET /user_api/bind_address_jwt/:address_id 使用用户 JWT，只有当前用户绑定的邮箱才可获取。address_id 取自上方绑定地址列表的 results[].id。返回的 jwt 可用于 Authorization: Bearer <jwt> 调用 /api/* 邮箱接口。

import requests

address_id = 1
response = requests.get(
    f"https://<你的worker地址>/user_api/bind_address_jwt/{address_id}",
    headers={
        "x-user-token": "<你的用户JWT Token>",
        # "x-custom-auth": "<你的网站密码>",
    },
)
print(response.json())  # {"jwt": "..."}

解绑邮箱

POST /user_api/unbind_address 使用用户 JWT，请求体为 {"address_id": 1}，成功返回 {"success": true}。此操作只移除当前用户与邮箱的关联，不删除邮箱或邮件，也不撤销已签发的地址 JWT。解绑前请保存邮箱凭据，以便之后继续访问或重新绑定。

import requests

response = requests.post(
    "https://<你的worker地址>/user_api/unbind_address",
    headers={
        "x-user-token": "<你的用户JWT Token>",
        # "x-custom-auth": "<你的网站密码>",
    },
    json={"address_id": 1},
)
print(response.json())  # {"success": True}

用户邮件列表

支持 address 过滤

import requests

url = "https://<你的worker地址>/user_api/mails"

querystring = {
    "limit":"20",
    "offset":"0",
    # address 为可选参数
    "address":"[email protected]"
}

headers = {
        "x-user-token": "<你的用户JWT Token>",
        # "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
    }

response = requests.get(url, headers=headers, params=querystring)

print(response.json())

注意：/user_api/mails 同样返回原始 RFC822 内容；请在客户端解析后提取 subject、text、html。

注意：后端 API 已移除关键词过滤功能。如需按内容过滤邮件，请使用前端界面的过滤输入框，该功能可过滤当前显示的页面。