邮箱服务
    • 邮件接收服务 API 文档说明
    • 新版本v2的接口
      • 用户端接口
        • 域名邮箱
          • 验证用户密钥
          • 获取活跃域名列表
          • 获取用户邮箱列表
          • 生成随机邮箱 (GET方法)
          • 生成随机邮箱
          • 批量生成随机邮箱 (GET方法)
          • 批量生成随机邮箱
          • 绑定自定义域名 (GET方法)
          • 绑定自定义域名
          • 导出邮箱地址列表
          • 获取邮箱邮件列表
          • 获取未读邮件列表
          • 获取邮件详情
          • 获取文档配置
          • 设置邮箱备注
          • 检查域名绑定权限
          • 获取用户绑定域名列表
          • 更新用户域名
          • 删除用户域名
          • 批量删除用户域名
          • 聚合未读邮件列表
          • 批量设置邮箱公开配置
          • 设置邮箱公开配置
          • 获取邮箱公开配置
          • 批量获取邮箱公开配置
          • 公开访问邮箱最新邮件
          • 批量获取指定邮箱最新邮件
          • 清空指定邮箱的全部邮件
          • 获取未读邮件列表
          • 创建清空全部邮件任务
          • 获取最近一次清空任务
        • 微软邮箱
          • 公开邮箱相关
            • 微软邮箱公开邮件列表
            • 微软邮箱-批量设置公开配置
            • 微软邮箱-设置单个公开配置
            • 微软邮箱-获取单个公开配置
            • 微软邮箱-批量获取公开配置
          • 微软邮箱-已获取的微软邮箱列表
          • 微软邮箱-获取邮件
          • 微软邮箱-已分配账号四段式列表
          • 微软邮箱-单账号四段式信息
          • 微软邮箱-设置账号备注
          • 微软邮箱-获取微软邮箱-支持批量
          • 微软邮箱-导出邮箱地址
      • 自提端
        • 自提客户-摘要信息
        • 自提客户-订单列表
        • 自提客户-创建订单
        • 自提客户-订单详情
        • 自提客户-订单子秘钥列表
        • 自提客户-子秘钥列表
        • 自提客户-注销子秘钥
        • 自提客户-启用子秘钥
        • 自提客户-收窄子秘钥权限
        • 自提客户-导出子秘钥邮箱
        • 自提客户-预览子秘钥额度调整
        • 自提客户-执行子秘钥额度调整
        • 兑换充值卡密
      • 获取服务基本信息
        GET
      • 注销当前登录密钥
        POST
      • 公开访问-获取邮箱公开配置
        GET
      • 公开访问-获取邮箱邮件列表
        GET
      • 公开访问-获取指定邮件详情
        GET
      • 微软邮箱公开访问-获取公开配置
        GET
      • 微软邮箱公开访问-获取最新邮件
        GET
      • 获取最新已发布公告
        GET
      • 验证用户密钥
        GET
      • 获取公告历史列表
        GET
      • 获取活跃域名列表
        GET
      • 获取公告详情
        GET
      • 获取用户邮箱列表
        GET
      • 标记公告已读
        POST
      • 生成随机邮箱
        POST
      • 提交用户反馈
        POST
      • 获取邮箱邮件列表
        GET
      • 额度置换
        POST
      • 获取邮件详情
        GET
      • 获取服务基本信息
        GET
      • 按 ID 获取清空任务详情
        GET
      • 批量设置邮箱公开配置
        POST
      • 获取教程文档链接
        GET
      • 更新教程文档链接
        POST
      • 按订单返还并注销子秘钥
        POST
      • 微软邮箱-全局账号列表
        GET
      • 微软邮箱-批量删除账号
        POST
      • 微软邮箱-直接导入账号
        POST
      • 微软邮箱-创建导入任务
        POST
      • 微软邮箱-导入任务列表
        GET
      • 微软邮箱-导入任务详情
        GET
      • 微软邮箱-上传导入任务分片
        POST
      • 微软邮箱-提交导入任务
        POST
      • 微软邮箱-导入任务日志
        GET
      • 微软邮箱-账号统计
        GET
      • 微软邮箱-统计快照列表
        GET
      • 微软邮箱-创建验证任务
        POST
      • 微软邮箱-验证任务列表
        GET
      • 微软邮箱-验证任务详情
        GET
      • 微软邮箱-验证任务日志
        GET
      • 微软邮箱-创建刷新令牌任务
        POST
      • 微软邮箱-刷新令牌任务列表
        GET
      • 微软邮箱-刷新令牌任务详情
        GET
      • 微软邮箱-刷新令牌任务日志
        GET
    • 旧版v1的接口
      • 获取服务基本信息
      • 验证用户密钥
      • 获取活跃域名列表
      • 获取用户邮箱列表
      • 生成随机邮箱
      • 获取邮箱邮件列表
      • 获取未读邮件列表
      • 获取邮件详情
      • 获取服务基本信息
    • 获取最新已发布公告
      GET
    • 获取公告历史列表
      GET
    • 获取公告详情
      GET
    • 标记公告已读
      POST
    • 提交用户反馈
      POST
    • 额度置换
      POST
    • 创建清空全部邮件任务
      POST
    • 获取最近一次清空任务
      GET
    • 按 ID 获取清空任务详情
      GET
    • 批量设置邮箱公开配置
      POST
    • 获取教程文档链接
      GET
    • 更新教程文档链接
      POST
    • 兑换充值卡密
      POST
    • 按订单返还并注销子秘钥
      POST
    • 数据模型
      • Schemas
      • Response
      • Mailbox
      • Domain
      • TooManyRequests
      • EmailSummary
      • MailboxDetail
      • EmailDetail
      • MailboxListResponse
      • EmailListResponse
      • Error
      • RateLimitError
      • PublicViewMode
      • PublicMailboxConfig
      • MailboxPublicStatusItem
      • MsAccountPublicStatusItem
      • PublicMailboxMessageListData
      • MsPublicMessage
      • SimpleSuccessResponse
      • MailboxPublicConfig
      • MailboxPublicConfigUpdateRequest
      • BatchMailboxPublicUpdateResponse
      • BatchMailboxPublicStatusItem
      • PublicMailboxMetaResponse
      • PublicMailboxMessagesResponse
      • PublicMailboxLatestResponse
      • ClearMailboxEmailsResponse
      • MsAccountPublicConfig
      • MsAccountBatchPublicUpdateResponse
      • MsAccountBatchPublicStatusItem
      • SelfPricingLevel
      • SelfSummaryData
      • SelfOrder
      • SelfCreatedKey
      • SelfOrderKey
      • SelfQuotaAdjustmentDetail
      • SelfQuotaAdjustmentData

    邮件接收服务 API 文档说明

    💡
    推荐优先使用V2版本接口,v1是为了兼容对接了旧版本接口的客户使用
    一定要做接口异常无法访问时让你的脚本自动停下的逻辑(做随眠处理,比如接口异常的时候等待30分钟重新检测接口状态),因为我们会定期停机维护升级!!!

    概述#

    本目录包含了邮件接收服务的完整客户端API文档

    认证方式#

    所有需要认证的API接口均使用API密钥:
    Header方式: X-API-Key: YOUR_API_KEY
    URL参数方式: ?user_key=YOUR_API_KEY

    服务器地址#

    v1旧版本api域名: http://email.ymb1668.com
    v2新版本api域名: http://email2.ymb1668.com

    数据格式#

    所有API接口均使用JSON格式进行数据交换:
    请求: Content-Type: application/json
    响应: Content-Type: application/json
    字符编码: UTF-8
    错误信息: 中文描述

    公开查看模式说明#

    public_view_mode=latest:仅允许通过“最新邮件”接口查看最近一封邮件
    public_view_mode=list:允许通过“邮件列表”接口分页查看邮件,并访问指定邮件详情
    当邮箱处于 list 模式时,请不要再调用“最新一封邮件”接口作为公开访问入口,否则会收到 403

    客户端限流说明#

    从 2026-03-13 起,客户端接口增加了按客户端 IP 的秒级限流
    命中限流时会返回 429,并带有 Retry-After 响应头

    版本对比#

    功能旧版APIv2 API
    基础邮箱管理✅✅
    邮件接收查看✅✅
    分页支持✅✅
    批量操作❌✅
    邮箱导出❌✅
    域名绑定❌✅
    域名管理❌✅
    自提客户❌✅
    微软邮箱❌✅
    公开访问❌✅
    邮箱公开状态❌✅
    频率限制❌✅

    文档结构#

    旧版API文档#

    包含以下核心接口:
    1.
    GET / - 获取服务基本信息
    2.
    GET /api - 获取服务基本信息
    3.
    GET /api/verify-key - 验证用户密钥
    4.
    GET /api/active-domains - 获取活跃域名列表
    5.
    GET /api/user/mailboxes - 获取用户邮箱列表
    6.
    POST /api/user/mailboxes/random - 生成随机邮箱
    7.
    GET /api/mailbox/{address}/emails - 获取邮箱邮件列表
    8.
    GET /api/mailbox/{address}/unread-emails - 获取未读邮件列表
    9.
    GET /api/emails/{id} - 获取邮件详情

    v2 普通用户接口#

    1.
    GET /api/v2/verify-key - 验证用户密钥(增强版)
    2.
    POST /api/v2/user/key/deactivate - 注销当前登录密钥
    3.
    GET /api/v2/active-domains - 获取活跃域名列表(增强版)
    4.
    GET /api/v2/system/docs - 获取文档配置
    5.
    GET /api/v2/user/mailboxes - 获取用户邮箱列表(支持分页和过滤)
    6.
    PUT /api/v2/user/mailboxes/{address}/remark - 设置邮箱备注
    7.
    DELETE /api/v2/user/mailboxes/{address}/emails - 清空指定邮箱的全部邮件
    8.
    GET/POST /api/v2/user/mailboxes/random - 生成随机邮箱(支持 domain / domains)
    9.
    GET/POST /api/v2/user/mailboxes/batch - 批量生成随机邮箱(支持 domain / domains)
    10.
    GET/POST /api/v2/user/domains/bind - 绑定自定义域名
    11.
    GET /api/v2/user/permissions/domain-bind - 检查域名绑定权限
    12.
    GET /api/v2/user/domains - 获取用户域名列表
    13.
    PUT /api/v2/user/domains/{id} - 更新用户域名
    14.
    DELETE /api/v2/user/domains/{id} - 删除用户域名
    15.
    POST /api/v2/user/domains/batch-delete - 批量删除用户域名
    16.
    GET /api/v2/user/mailboxes/export - 导出邮箱地址列表
    17.
    GET /api/v2/mailbox/{address}/emails - 获取邮箱邮件列表
    18.
    GET /api/v2/mailbox/{address}/unread-emails - 获取未读邮件列表
    19.
    GET /api/v2/user/unread-emails - 聚合未读邮件列表
    20.
    GET /api/v2/emails/{id} - 获取邮件详情
    21.
    PUT /api/v2/mailbox/batch/public - 批量设置邮箱公开配置
    22.
    PUT /api/v2/mailbox/{address}/public - 设置邮箱公开配置
    23.
    GET /api/v2/mailbox/{address}/public - 获取邮箱公开配置
    24.
    POST /api/v2/mailbox/batch/public/status - 批量获取邮箱公开配置

    v2 自提客户接口#

    1.
    GET /api/v2/user/self/summary - 获取自提客户摘要
    2.
    GET /api/v2/user/self/orders - 获取订单列表
    3.
    POST /api/v2/user/self/orders - 创建订单
    4.
    GET /api/v2/user/self/orders/{id} - 获取订单详情
    5.
    GET /api/v2/user/self/orders/{id}/keys - 获取订单子秘钥列表
    6.
    GET /api/v2/user/self/keys - 获取子秘钥列表
    7.
    POST /api/v2/user/self/keys/{id}/deactivate - 注销子秘钥
    8.
    POST /api/v2/user/self/keys/{id}/activate - 启用子秘钥
    9.
    POST /api/v2/user/self/keys/{id}/permissions - 收窄子秘钥权限
    10.
    POST /api/v2/user/self/keys/quota-adjustments/preview - 预览子秘钥额度调整
    11.
    POST /api/v2/user/self/keys/quota-adjustments/execute - 执行子秘钥额度调整
    12.
    POST /api/v2/user/self/keys/{id}/export-mailboxes - 导出子秘钥邮箱

    微软邮箱客户端接口(ms-mail)#

    1.
    GET /api/ms-mail/accounts/assigned - 获取已分配账号列表
    2.
    POST /api/ms-mail/accounts/assigned/credentials - 获取已分配账号四段式
    3.
    POST /api/ms-mail/accounts/{id}/credentials - 获取单账号四段式
    4.
    PUT /api/ms-mail/accounts/{id}/remark - 设置账号备注
    5.
    POST /api/ms-mail/accounts/assign - 分配账号
    6.
    POST /api/ms-mail/messages/refresh - 刷新邮件
    7.
    GET /api/ms-mail/accounts/export - 导出微软邮箱地址
    8.
    PUT /api/ms-mail/account/batch/public - 批量设置公开配置
    9.
    PUT /api/ms-mail/account/{email}/public - 设置单个公开配置
    10.
    GET /api/ms-mail/account/{email}/public - 获取单个公开配置
    11.
    POST /api/ms-mail/account/batch/public/status - 批量获取公开配置

    公开接口#

    1.
    GET /api/v2/public/mailbox/latest - 公开访问邮箱最新邮件
    2.
    GET /api/v2/public/mailbox/meta - 获取公开邮箱配置
    3.
    GET /api/v2/public/mailbox/messages - 获取公开邮箱邮件列表
    4.
    GET /api/v2/public/mailbox/emails/{id} - 获取公开邮箱指定邮件详情
    5.
    GET /api/ms-mail/public/meta - 获取微软公开邮箱配置
    6.
    GET /api/ms-mail/public/messages - 公开访问微软邮箱邮件列表
    7.
    GET /api/ms-mail/public/latest - 公开访问微软邮箱最新邮件

    支持AI的mcp调用#

    image.png

    支持AI提示词调用#

    https://uenb3vr91v.apifox.cn/llms.txt

    兼容性说明#

    旧版API: 100%向后兼容,现有客户端可直接使用
    v2 API: 新功能API,建议新客户端使用
    共存: 两个版本可以同时运行,互不影响

    技术支持#

    如需技术支持,请联系客服
    修改于 2026-04-03 17:31:31
    下一页
    验证用户密钥
    Built with