Luck MailLuck Mail

API Reference

开放 API 文档

当前版本提供基于 API Key 的开放接口，可用于查询可用域名、创建临时邮箱、读取邮件以及管理自有域名。 控制台生成的 API Key 前缀统一为 luck_。

鉴权方式

所有开放 API 请求都需要通过 X-API-Key 请求头传递密钥。

X-API-Key: luck_your_api_key_here

Base URL

https://mail.weiclu.cn

已开放端点

GET/v1/available-domains查询当前 API Key 可用的域名列表（含管理员分配结果）
GET/v1/emails获取当前 API Key 名下的邮箱列表
POST/v1/emails创建临时邮箱，受管理员策略与域名权限控制
GET/v1/emails/:emailId/messages列出邮箱中的邮件
GET/v1/emails/:emailId/messages/:messageId获取单封邮件详情
DELETE/v1/emails/:emailId删除临时邮箱
GET/v1/domains获取当前用户自有域名列表
POST/v1/domains添加自有域名
GET/v1/domains/:id/verify校验自有域名的 MX / TXT 配置
DELETE/v1/domains/:id删除自有域名

调用示例

curl
curl https://mail.weiclu.cn/v1/emails \
  -X POST \
  -H 'X-API-Key: luck_xxxx...' \
  -H 'Content-Type: application/json' \
  -d '{
    "prefix": "luwa",
    "domain": "luck.mail",
    "expiresInHours": 24
  }'
{
  "success": true,
  "data": {
    "id": "email_123",
    "address": "luwa@luck.mail",
    "domain": "luck.mail",
    "prefix": "luwa",
    "messageCount": 0,
    "createdAt": "2026-04-05T10:00:00.000Z",
    "expiresAt": "2026-04-06T10:00:00.000Z"
  }
}

说明

  • 开放 API 与控制台共用同一套邮箱策略，管理员冻结账户后，API Key 也会同步失效。
  • 建议先调用 /v1/available-domains 获取当前可用域名，再发起邮箱创建请求。
  • 删除邮箱或域名会影响后续 API 调用，请在业务侧做好重试与异常处理。