OpenAPI

将 MyMail 接入你的程序

所有客户请求均使用管理员签发的 mlr_... Key;邮件商上游 Key 始终保留在 MyMail 服务端。

复制给 AI

AI 一键接入提示词

复制后直接发给 Claude、ChatGPT、Codex 或其他编程 AI。AI 会先分析你的现有项目,再使用环境变量安全接入 MyMail。

安全提示:提示词只包含 Key 的环境变量名,不会读取或复制浏览器里保存的真实客户 Key。

快速开始

Base URL:正在读取...

推荐使用 Bearer 鉴权,也兼容 X-API-Key。请从服务端调用;不要把 Key 嵌入公开网站或 URL。

请求头Authorization: Bearer $MOYUMAIL_API_KEY
GET/openapi/v1/me

验证 Key 和读取额度

不扣点、不增加调用次数。返回客户名称、用量、限速、剩余额度及客户实际邮箱扣点。

GET/openapi/v1/mailboxes?limit=...

获取最近邮箱和公开链接

只返回当前客户 Key 领取的邮箱记录,不扣点、不增加调用次数。每条记录包含 publicQuery.url;敏感凭据不会返回。

POST/openapi/v1/mailboxes

领取邮箱

基础字段为 type。接码类型还要传 service;outlook-code 可传 domain。

成功响应的 mailroom.publicQueryUrl 是该邮箱的公开查件链接。

POST/openapi/v1/messages

查询平台邮箱

传入邮箱地址;建议每 5 秒轮询一次并从响应中提取六位验证码。旧版 GET /openapi/v1/messages?email=... 继续兼容。

POST/openapi/v1/outlook/messages

Outlook 完整账号查件

使用领取结果里的 clientId 和 refreshToken 读取 Microsoft Graph 最近邮件。

邮箱类型和附加参数

type名称附加参数说明

错误处理

状态码含义建议
400参数格式不正确检查 type、service、domain、email
401Key 缺失或无效更换客户 Key
403Key 已停用联系管理员启用
429限速或额度不足读取 message / Retry-After 后退避
5xxMyMail 或上游暂时异常稍后重试并保留错误信息