API 文档 - Outlook Mail Tool

📋 使用说明

⚠️ 本文档所有接口仅限本站购买的账号使用。通过其他渠道获取的账号均不支持调用，请务必确认您的账号来源。

欢迎使用 Outlook Mail Tool API 服务。在使用前，请注意以下事项：

#	说明
1	本接口仅支持通过本站购买的 Outlook 邮箱账号，非本站账号调用将返回凭据未找到的错误。
2	调用时需提供邮箱地址和购买时对应的密码，系统将自动匹配令牌并获取邮件。
3	单账号接口为免费公开接口，无需申请 API Key，基于 IP 限流（每分钟 10 次）。
4	批量接口需申请 API Key并开通批量权限，请联系管理员获取。

还没有账号？

前往淘宝店铺购买，即可立即使用 API 服务

🛒 前往购买

📖 接口概览

接口	方法	路径	认证	限流
单账号获取	POST	`/api/v1/mail`	无需认证	10次/分钟/IP
批量获取	POST	`/api/v1/batch-mail`	需 API Key	按Key配置

✅ 单账号接口为公开接口，无需申请 Key，传入账号密码即可调用。基于 IP 严格限流（每分钟 10 次）。

ℹ️ 批量接口需要 API Key 认证，请联系管理员获取 Key 并开通批量权限。

⏱️ 限流说明

ℹ️ 采用滑动窗口算法，窗口期为 60 秒。

接口	限流策略	默认额度	可配置
单账号获取	基于 IP	10 次/分钟	固定
批量获取	基于 API Key	60 次/分钟	管理员可调

📨 单账号获取邮件

POST /api/v1/mail 无需认证

✅ 公开接口，无需 API Key。传入邮箱账号和密码即可获取最新邮件。每个 IP 每分钟限 10 次请求。

请求参数

参数	类型	必填	说明
`email`	String	必填	邮箱地址
`password`	String	必填	邮箱密码（用于匹配数据库中的令牌凭据）
`count`	Number	选填	获取邮件数量，默认 `1`（最新 1 封）

请求示例

                        
POST /api/v1/mail
Content-Type: application/json

{
    "email": "user@outlook.com",
    "password": "your_password",
    "count": 1
}
                    

响应示例（成功）

                        
{
    "success": true,
    "email": "user@outlook.com",
    "count": 1,
    "mails": [
        {
            "subject": "Your verification code",
            "from": "noreply@example.com",
            "date": "2026-04-08 12:00:00",
            "content": "Your code is 123456",
            "verificationCode": "123456"
        }
    ]
}
                    

响应示例（失败）

                        
{
    "success": false,
    "error": "未找到该邮箱，请检查账号和密码是否正确"
}
                    

cURL 示例

curl -X POST http://localhost:10088/api/v1/mail \ -H "Content-Type: application/json" \ -d '{"email":"user@outlook.com","password":"xxx","count":1}'

📦 批量获取邮件

POST /api/v1/batch-mail 需要 API Key

⚠️ 批量接口需要 API Key 认证 + 批量权限。请联系管理员获取 Key 并开通。单次最多 20 个账号。

认证方式

                        
X-API-Key: ot_your_api_key_here
Content-Type: application/json

请求参数（数组中每个元素）

参数	类型	必填	说明
`email`	String	必填	邮箱地址
`password`	String	必填	邮箱密码

请求示例

                        
POST /api/v1/batch-mail
X-API-Key: ot_xxxxxxxx
Content-Type: application/json

[
    { "email": "user1@outlook.com", "password": "pass1" },
    { "email": "user2@outlook.com", "password": "pass2" }
]
                    

响应示例

                        
{
    "success": true,
    "total": 2,
    "results": [
        {
            "email": "user1@outlook.com",
            "success": true,
            "count": 1,
            "mails": [...]
        },
        {
            "email": "user2@outlook.com",
            "success": false,
            "error": "未找到凭据"
        }
    ]
}
                    

⚠️ 错误码说明

状态码	含义	说明
429	请求过于频繁	超过 IP 或 Key 限流频次，请稍后重试
401	认证失败	API Key 缺失、无效或已禁用（批量接口）
403	权限不足	批量接口未开通权限
400	参数错误	缺少必填参数或格式错误
404	未找到	邮箱账号不存在或凭据未找到
500	服务器错误	服务端处理异常

🧪 在线测试

✅ 直接输入邮箱和密码即可测试，无需 API Key。

邮箱地址

邮箱密码

获取邮件数量

// 响应结果将显示在这里

📘 API 文档