openapi: 3.1.0 info: title: 检查您的电子邮件API description: |- 的应用程序编程接口（API） Mailexam.cn 电子邮件测试系统将允许您设置 自动化测试和CI/CD场景 [知识库](https://wiki.mailexam.cn) termsOfService: https://mailexam.cn/agreement contact: name: 支持 email: support@mailexam.cn license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html version: 1.0.0 externalDocs: description: 网站 url: https://mailexam.cn servers: - url: https://mailexam.cn/api/v1 description: 产品服务器（使用真实数据） tags: - name: project description: 工程项目 - name: inbox description: 邮箱 - name: email description: 电邮 paths: /project: get: tags: - project summary: 项目一览表 responses: '200': description: 成功运作 content: application/json: schema: type: array items: $ref: '#/components/schemas/ProjectResponse' '403': description: 访问权限不足 security: - token: /project/store: post: tags: - project summary: 创建项目 requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectRequest' responses: '201': description: 成功运作 '403': description: 访问权限不足 security: - token: /project/{uuid}: get: tags: - project summary: 项目资料 parameters: - name: uuid in: path description: 项目ID required: true schema: type: string format: uuid responses: '200': description: 成功运作 content: application/json: schema: $ref: '#/components/schemas/ProjectResponse' '403': description: 访问权限不足 '404': description: ID未找到的项目 security: - token: /project/{uuid}/update: put: tags: - project summary: 更新项目信息 parameters: - name: uuid in: path description: 项目ID required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectRequest' responses: '200': description: 成功运作 content: application/json: schema: $ref: '#/components/schemas/ProjectResponse' '403': description: 访问权限不足 '404': description: ID未找到的项目 security: - token: /project/{uuid}/delete: delete: tags: - project summary: 删除项目 parameters: - name: uuid in: path description: 项目ID required: true schema: type: string format: uuid responses: '200': description: 成功运作 '403': description: 访问权限不足 '404': description: ID未找到的项目 security: - token: /inbox: get: tags: - inbox summary: 邮箱列表 parameters: - name: project in: query description: '项目ID' required: true schema: type: string responses: '200': description: 成功运作 content: application/json: schema: type: array items: $ref: '#/components/schemas/InboxResponse' '403': description: 访问权限不足 security: - token: /inbox/store: post: tags: - inbox summary: 创建邮箱 requestBody: content: application/json: schema: $ref: '#/components/schemas/InboxRequest' responses: '201': description: 成功运作 content: application/json: schema: $ref: '#/components/schemas/InboxResponse' '403': description: 访问权限不足 security: - token: /inbox/{uuid}: get: tags: - inbox summary: 邮箱信息 parameters: - name: uuid in: path description: 邮箱ID required: true schema: type: string format: uuid responses: '200': description: 成功运作 content: application/json: schema: $ref: '#/components/schemas/InboxResponse' '403': description: 访问权限不足 '404': description: ID找不到邮箱 security: - token: /inbox/{uuid}/default: put: tags: - inbox summary: 设置"默认"邮箱标志 parameters: - name: uuid in: path description: 邮箱ID required: true schema: type: string format: uuid responses: '200': description: 成功运作 content: application/json: schema: $ref: '#/components/schemas/InboxResponse' '403': description: 访问权限不足 '404': description: ID找不到邮箱 security: - token: /inbox/{uuid}/update: put: tags: - inbox summary: 更新邮箱信息 parameters: - name: uuid in: path description: 邮箱ID required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/InboxRequest' responses: '200': description: 成功运作 content: application/json: schema: $ref: '#/components/schemas/InboxResponse' '403': description: 访问权限不足 '404': description: ID找不到邮箱 security: - token: /inbox/{uuid}/delete: delete: tags: - inbox summary: 删除邮箱 parameters: - name: uuid in: path description: 邮箱ID required: true schema: type: string format: uuid responses: '200': description: 成功运作 '403': description: 访问权限不足 '404': description: ID找不到邮箱 security: - token: /email: get: tags: - email summary: 电子邮件列表 parameters: - name: inbox in: query description: '邮箱ID' required: true schema: type: string responses: '200': description: 成功运作 content: application/json: schema: type: array items: $ref: '#/components/schemas/EmailShort' '403': description: 访问权限不足 security: - token: /email/{uuid}: get: tags: - email summary: 电邮资料 parameters: - name: uuid in: path description: 电子邮件ID required: true schema: type: string format: uuid responses: '200': description: 成功运作 content: application/json: schema: $ref: '#/components/schemas/EmailDetailed' '403': description: 访问权限不足 '404': description: 未找到ID的电子邮件 security: - token: /email/{uuid}/attachment: get: tags: - email summary: 电子邮件附件 parameters: - name: uuid in: path description: 电子邮件ID required: true schema: type: string format: uuid - name: cid in: query description: '附件ID' required: true schema: type: string responses: '200': description: 成功运作 content: application/json: schema: $ref: '#/components/schemas/EmailDetailed' '403': description: 访问权限不足 '404': description: 未找到ID的电子邮件 security: - token: /email/{uuid}/unread: put: tags: - email summary: 设置/取消设置电子邮件的"未读"标志 parameters: - name: uuid in: path description: 电子邮件ID required: true schema: type: string format: uuid requestBody: content: application/json: schema: type: object properties: unread: type: boolean examples: [true] responses: '200': description: 成功运作 content: application/json: schema: $ref: '#/components/schemas/EmailDetailed' '403': description: 访问权限不足 '404': description: 未找到ID的电子邮件 security: - token: /email/{uuid}/like: put: tags: - email summary: 像电子邮件 parameters: - name: uuid in: path description: 电子邮件ID required: true schema: type: string format: uuid requestBody: content: application/json: schema: type: object properties: like: type: boolean examples: [true] responses: '200': description: 成功运作 content: application/json: schema: $ref: '#/components/schemas/EmailDetailed' '403': description: 访问权限不足 '404': description: 未找到ID的电子邮件 security: - token: /email/{uuid}/dislike: put: tags: - email summary: 不喜欢电子邮件 parameters: - name: uuid in: path description: 电子邮件ID required: true schema: type: string format: uuid requestBody: content: application/json: schema: type: object properties: dislike: type: boolean examples: [true] responses: '200': description: 成功运作 content: application/json: schema: $ref: '#/components/schemas/EmailDetailed' '403': description: 访问权限不足 '404': description: 未找到ID的电子邮件 security: - token: /email/{uuid}/relay: put: tags: - email summary: 向中继服务器发送电子邮件 parameters: - name: uuid in: path description: 电子邮件ID required: true schema: type: string format: uuid responses: '200': description: 成功运作 content: application/json: schema: $ref: '#/components/schemas/EmailDetailed' '403': description: 访问权限不足 '404': description: 未找到ID的电子邮件 '422': description: 重传错误 security: - token: /email/{uuid}/delete: delete: tags: - email summary: 删除电子邮件 parameters: - name: uuid in: path description: 电子邮件ID required: true schema: type: string format: uuid responses: '200': description: 成功运作 '403': description: 访问权限不足 '404': description: 未找到ID的电子邮件 security: - token: components: schemas: ProjectRequest: type: object properties: name: type: string examples: ["我的项目"] description: type: string examples: [null] ProjectResponse: type: object properties: uuid: type: string examples: ["536a47df-5aad-44d0-8163-a39bb55abe0b"] name: type: string examples: ["我的项目"] description: type: string examples: [null] user: type: object properties: uuid: type: string examples: ["984f1f70-21e1-4244-bbb7-734ac151dcdc"] name: type: string examples: ["支援服务 Mailexam.cn"] email: type: string examples: ["support@mailexam.cn"] InboxRequest: type: object properties: project_uuid: type: string examples: ["984f1f70-21e1-4244-bbb7-734ac151dcdc"] name: type: string examples: ["所有电邮"] has_autorelay: type: boolean examples: [false] relay_host: type: string examples: [null] relay_port: type: string examples: [null] relay_pass: type: string examples: [null] InboxResponse: type: object properties: uuid: type: string examples: ["deab7974-a252-4412-9169-b965116b63cf"] project_uuid: type: string examples: ["984f1f70-21e1-4244-bbb7-734ac151dcdc"] name: type: string examples: ["所有电邮"] is_default: type: boolean examples: [false] has_autorelay: type: boolean examples: [false] relay_host: type: string examples: [null] relay_port: type: string examples: [null] relay_user: type: string examples: [null] relay_pass: type: string examples: [null] EmailShort: type: object properties: uuid: type: string examples: ["e2f9a506-d766-4935-be11-c413384de020"] from: type: string examples: ["\"Mailexam.cn\" "] to: type: string examples: ["支援服务 Mailexam.cn "] cc: type: string examples: [null] subject: type: string examples: ["Mailexam.cn 连接参数"] human_size: type: string examples: ["113 字节"] date: type: string examples: ["2025-03-01T08:58:49.000000Z"] attachments: type: boolean examples: [true] unread: type: boolean examples: [false] like: type: boolean examples: [true] dislike: type: boolean examples: [false] EmailDetailed: type: object properties: uuid: type: string examples: ["e2f9a506-d766-4935-be11-c413384de020"] from: type: string examples: ["\"Mailexam.cn\" "] to: type: string examples: ["支援服务 Mailexam.cn "] cc: type: string examples: [null] subject: type: string examples: ["Mailexam.cn 连接参数"] size: type: integer examples: [115710] human_size: type: string examples: ["113 字节"] date: type: string examples: ["2025-03-01T08:58:49.000000Z"] attachments: type: boolean examples: [true] unread: type: boolean examples: [false] like: type: boolean examples: [true] dislike: type: boolean examples: [false] body: type: object properties: html: type: string examples: [null] text: type: string examples: [null] raw: type: string examples: [null] attachments: type: array examples: [] headers: type: array examples: [] relay: type: array examples: [] securitySchemes: token: type: apiKey name: token in: query