📖 API 文档
寻游取件 API 完整使用指南
必看:OAuth2 API 使用流程
OAuth2 API 使用 refresh_token 进行身份验证,适合需要长期访问的场景。建议按以下流程操作:
/api/mail-count 获取当前邮箱中的邮件总数/api/mail-by-index,设置 index = 邮件数量 获取最新邮件index = 邮件数量 即可准确获取刚刚发送的验证码邮件。
必看:Graph API 推荐使用流程
Graph API 是微软官方提供的 RESTful API,相比 IMAP 更加稳定高效。推荐按以下流程操作:
/api/graph/mail-count 获取当前邮箱中的邮件总数/api/graph/mail-by-index,设置 index = N 获取最新邮件(N 为邮件总数)• index 从 1 开始,1 表示最旧的邮件,N 表示最新的邮件
推荐使用 Graph API:更稳定、响应更快、支持更多功能
必看:IMAP API 使用流程
IMAP API 使用邮箱地址和密码进行身份验证,适合快速访问邮件。支持自动识别服务器配置。
/api/imap/fetch-emails,提供邮箱地址和密码即可获取邮件自动配置:支持autoconfig协议,自动识别IMAP服务器地址和SSL设置
广泛支持:支持各种邮件服务提供商
获取邮件数量
获取指定邮箱文件夹中的邮件总数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| refresh_token | string | ✅ 是 | 用于身份验证的 refresh_token |
| client_id | string | ✅ 是 | 客户端 ID |
| string | ✅ 是 | 邮箱地址 | |
| mailbox | string | ❌ 否 | 邮箱文件夹 (INBOX / Junk),默认 INBOX |
| server | string | ❌ 否 | IMAP 服务器地址,默认 outlook.live.com |
获取第N封邮件
获取指定序号的邮件,index=1 表示第一封(最旧的),index=5 表示第5封,以此类推
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| refresh_token | string | ✅ 是 | 用于身份验证的 refresh_token |
| client_id | string | ✅ 是 | 客户端 ID |
| string | ✅ 是 | 邮箱地址 | |
| mailbox | string | ❌ 否 | 邮箱文件夹 (INBOX / Junk),默认 INBOX |
| index | integer | ❌ 否 | 邮件序号,从1开始,1表示第一封(最旧的),默认1 |
获取最新一封邮件
获取邮箱中最新(最后一封)的邮件,返回邮件序号和总数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| refresh_token | string | ✅ 是 | 用于身份验证的 refresh_token |
| client_id | string | ✅ 是 | 客户端 ID |
| string | ✅ 是 | 邮箱地址 | |
| mailbox | string | ❌ 否 | 邮箱文件夹 (INBOX / Junk),默认 INBOX |
| server | string | ❌ 否 | IMAP 服务器地址,默认 outlook.live.com |
获取全部邮件
获取邮箱中的所有邮件,自动提取6位数字验证码
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| refresh_token | string | ✅ 是 | 用于身份验证的 refresh_token |
| client_id | string | ✅ 是 | 客户端 ID |
| string | ✅ 是 | 邮箱地址 | |
| mailbox | string | ✅ 是 | 邮箱文件夹 (INBOX / Junk) |
清空邮箱
清空指定邮箱文件夹中的所有邮件,支持清空收件箱或垃圾箱
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| refresh_token | string | ✅ 是 | 用于身份验证的 refresh_token |
| client_id | string | ✅ 是 | 客户端 ID |
| string | ✅ 是 | 邮箱地址 | |
| mailbox | string | ❌ 否 | 邮箱文件夹 (INBOX / Junk),默认 INBOX |
| server | string | ❌ 否 | IMAP 服务器地址,默认 outlook.live.com |
获取邮件(原接口)
获取指定数量的邮件,同时返回 INBOX 和 Junk 的邮件(旧版接口,兼容保留)
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| refresh_token | string | ✅ 是 | 用于身份验证的 refresh_token |
| client_id | string | ✅ 是 | 客户端 ID |
| string | ✅ 是 | 邮箱地址 | |
| count | integer | ❌ 否 | 获取数量,默认 1 |
| server | string | ❌ 否 | IMAP 服务器地址,默认 outlook.live.com |
OAuth2 - 刷新 Token
单独刷新 OAuth2 refresh_token,延长 token 有效期至 90 天
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| refresh_token | string | ✅ 是 | 当前的 refresh_token |
| client_id | string | ✅ 是 | 客户端 ID |
IMAP API 接口说明
server = IMAP服务器地址(可选,不输入自动识别)use_ssl = 是否使用SSL(可选,默认true)other_email = 垃圾箱文件夹名称(可选,默认Junk)
IMAP - 获取邮件
使用邮箱地址和密码获取邮件,支持自动识别服务器配置
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | ✅ 是 | 邮箱地址 | |
| password | string | ✅ 是 | 邮箱密码或应用专用密码 |
| count | integer | ❌ 否 | 获取邮件数量,默认1 |
| server | string | ❌ 否 | IMAP服务器地址,不输入自动识别 |
| use_ssl | boolean | ❌ 否 | 是否使用SSL,默认true |
| other_email | string | ❌ 否 | 垃圾箱文件夹名称,默认Junk |
IMAP - 获取邮件数量
获取指定邮箱文件夹中的邮件总数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | ✅ 是 | 邮箱地址 | |
| password | string | ✅ 是 | 邮箱密码或应用专用密码 |
| mailbox | string | ❌ 否 | 邮箱文件夹 (INBOX / Junk),默认INBOX |
| server | string | ❌ 否 | IMAP服务器地址,不输入自动识别 |
| use_ssl | boolean | ❌ 否 | 是否使用SSL,默认true |
IMAP - 获取第N封邮件
获取指定序号的邮件,index=1 表示第一封(最旧的),index=N 表示第N封,以此类推
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | ✅ 是 | 邮箱地址 | |
| password | string | ✅ 是 | 邮箱密码或应用专用密码 |
| mailbox | string | ❌ 否 | 邮箱文件夹 (INBOX / Junk),默认INBOX |
| index | integer | ❌ 否 | 邮件序号,从1开始,1表示第一封(最旧的),默认1 |
| server | string | ❌ 否 | IMAP服务器地址,不输入自动识别 |
| use_ssl | boolean | ❌ 否 | 是否使用SSL,默认true |
IMAP - 获取最新一封邮件
获取邮箱中最新(最后一封)的邮件,返回邮件序号和总数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | ✅ 是 | 邮箱地址 | |
| password | string | ✅ 是 | 邮箱密码或应用专用密码 |
| mailbox | string | ❌ 否 | 邮箱文件夹 (INBOX / Junk),默认INBOX |
| server | string | ❌ 否 | IMAP服务器地址,不输入自动识别 |
| use_ssl | boolean | ❌ 否 | 是否使用SSL,默认true |
IMAP - 获取最新邮件
获取最新一封邮件
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | ✅ 是 | 邮箱地址 | |
| password | string | ✅ 是 | 邮箱密码或应用专用密码 |
| mailbox | string | ❌ 否 | 邮箱文件夹 (INBOX / Junk),默认INBOX |
| server | string | ❌ 否 | IMAP服务器地址,不输入自动识别 |
| use_ssl | boolean | ❌ 否 | 是否使用SSL,默认true |
| other_email | string | ❌ 否 | 垃圾箱文件夹名称,默认Junk |
IMAP - 获取全部邮件
获取指定文件夹中的全部邮件(最多100封)
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | ✅ 是 | 邮箱地址 | |
| password | string | ✅ 是 | 邮箱密码或应用专用密码 |
| mailbox | string | ❌ 否 | 邮箱文件夹 (INBOX / Junk),默认INBOX |
| server | string | ❌ 否 | IMAP服务器地址,不输入自动识别 |
| use_ssl | boolean | ❌ 否 | 是否使用SSL,默认true |
| other_email | string | ❌ 否 | 垃圾箱文件夹名称,默认Junk |
Graph API 接口说明
INBOX = 收件箱 |
Junk = 垃圾箱支持大小写:inbox, junk, junkemail 也有效
Graph API - 刷新 Token
单独刷新 refresh_token,延长 token 有效期至 90 天
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| refresh_token | string | ✅ 是 | 当前的 refresh_token |
| client_id | string | ✅ 是 | 客户端 ID |
Graph API - 获取邮件数量
使用 Microsoft Graph API 获取指定邮箱文件夹中的邮件总数,响应更快更稳定
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| refresh_token | string | ✅ 是 | 用于身份验证的 refresh_token |
| client_id | string | ✅ 是 | 客户端 ID |
| string | ✅ 是 | 邮箱地址 | |
| mailbox | string | ❌ 否 | 邮箱文件夹 (INBOX / Junk),默认 INBOX (支持大小写: inbox, junk, junkemail 也有效) |
Graph API - 获取第N封邮件
使用 Microsoft Graph API 获取指定序号的邮件,index=1 表示最旧邮件,index=N 表示最新邮件
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| refresh_token | string | ✅ 是 | 用于身份验证的 refresh_token |
| client_id | string | ✅ 是 | 客户端 ID |
| string | ✅ 是 | 邮箱地址 | |
| mailbox | string | ❌ 否 | 邮箱文件夹 (INBOX / Junk),默认 INBOX (支持大小写: inbox, junk, junkemail 也有效) |
| index | integer | ❌ 否 | 邮件序号,从1开始,1表示最旧邮件,N表示最新,默认1 |
Graph API - 获取最新一封邮件
使用 Microsoft Graph API 获取邮箱中最新的一封邮件,返回邮件序号和总数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| refresh_token | string | ✅ 是 | 用于身份验证的 refresh_token |
| client_id | string | ✅ 是 | 客户端 ID |
| string | ✅ 是 | 邮箱地址 | |
| mailbox | string | ❌ 否 | 邮箱文件夹 (INBOX / Junk),默认 INBOX (支持大小写: inbox, junk, junkemail 也有效) |
Graph API - 获取全部邮件
使用 Microsoft Graph API 获取邮箱中的全部邮件,自动提取6位数字验证码
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| refresh_token | string | ✅ 是 | 用于身份验证的 refresh_token |
| client_id | string | ✅ 是 | 客户端 ID |
| string | ✅ 是 | 邮箱地址 | |
| mailbox | string | ❌ 否 | 邮箱文件夹 (INBOX / Junk),默认 INBOX (支持大小写: inbox, junk, junkemail 也有效) |
| top | integer | ❌ 否 | 获取数量,默认 100,最大 1000 |
邮件查看 OAuth2
提供基于 OAuth2 认证的邮件查看 Web 界面,支持查看收件箱和垃圾箱邮件
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | ✅ 是 | 邮箱地址 | |
| client_id | string | ✅ 是 | 客户端 ID |
| refresh_token | string | ✅ 是 | 用于身份验证的 refresh_token |
响应格式
{"inbox": [{"content": "邮件内容", "date": "邮件日期", "from": "发件人", "fullContent": "完整邮件内容", "subject": "邮件主题"}], "junk": []}
实时更新:页面会自动加载和显示最新的邮件
多邮箱支持:通过参数指定不同的邮箱地址
安全认证:使用 OAuth2 认证,确保邮件访问的安全性
便捷操作:直接在浏览器中打开即可查看邮件,无需安装额外软件
邮件查看 Graph
提供基于 Graph API 的邮件查看 Web 界面,支持查看收件箱和垃圾箱邮件
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | ✅ 是 | 邮箱地址 | |
| client_id | string | ✅ 是 | 客户端 ID |
| refresh_token | string | ✅ 是 | 用于身份验证的 refresh_token |
响应格式
{"inbox": [{"content": "邮件内容", "date": "邮件日期", "from": "发件人", "fullContent": "完整邮件内容", "subject": "邮件主题"}], "junk": []}
性能优势:Graph API 相比传统 IMAP 协议响应更快
功能丰富:支持更多高级邮件操作和数据获取功能
用户友好:提供可视化的邮件查看界面,无需编写代码
实时更新:页面会自动加载和显示最新的邮件
多邮箱支持:通过参数指定不同的邮箱地址