邮箱
管理 SMTP 邮箱、凭据和邮箱域名。 示例使用 A2A 代码模式。MCP 通过execute 工具公开相同的代码模式。
函数
mailboxes.add
mailboxes.add.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | mailbox.create | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | mailbox.create |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | POST /v1/public/accounts/{account_id}/mailboxes |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
domain | str | 是 |
first_name | str | 是 |
last_name | str | 是 |
local_part | str | 是 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
created_at | str | 是 |
domain_id | str | 是 |
domain_name | str | 是 |
first_name | str | 是 |
id | str | 是 |
last_name | str | 是 |
local_part | str | 是 |
primary_email | str | 是 |
quota | {"allowed": int, "used": int} | 是 |
status | str | 是 |
updated_at | str | 是 |
aliases | [{"alias": str, "is_catch_all"?: bool}] | 否 |
workspace_id | str | null | 否 |
workspace_name | str | null | 否 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应:
mailboxes.aliases.create
mailboxes.aliases.create.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | mailbox.alias.manage | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | mailbox.alias.manage |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
mailbox | str | 是 |
alias | str | 是 |
is_catch_all | bool | 否 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
alias | str | 是 |
is_catch_all | bool | 否 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应:
mailboxes.aliases.delete
mailboxes.aliases.delete.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | mailbox.alias.manage | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | mailbox.alias.manage |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | DELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases/{alias} |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
alias | str | 是 |
mailbox | str | 是 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
result | {} | 是 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应:
mailboxes.bulk_add
mailboxes.bulk_add.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | mailbox.create | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | mailbox.create |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | POST /v1/public/accounts/{account_id}/mailboxes/bulk |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
domain | str | 是 |
items | [{"first_name": str, "last_name": str, "local_part": str}] | 是 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
created | [{"index": int, "mailbox": {"created_at": str, "domain_id": str, "domain_name": str, "first_name": str, "id": str, "last_name": str, "local_part": str, "primary_email": str, "quota": {"allowed": int, "used": int}, "status": str, "updated_at": str, "aliases"?: [{"alias": str, "is_catch_all"?: bool}], "workspace_id"?: str | null, "workspace_name"?: str | null}}] | 是 |
failed | [{"code": str, "index": int, "message": str}] | 是 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应:
mailboxes.get
mailboxes.get.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | mailbox.view | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | mailbox.view |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | GET /v1/public/accounts/{account_id}/mailboxes/{mailbox} |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
mailbox | str | 是 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
created_at | str | 是 |
domain_id | str | 是 |
domain_name | str | 是 |
first_name | str | 是 |
id | str | 是 |
last_name | str | 是 |
local_part | str | 是 |
primary_email | str | 是 |
quota | {"allowed": int, "used": int} | 是 |
status | str | 是 |
updated_at | str | 是 |
aliases | [{"alias": str, "is_catch_all"?: bool}] | 否 |
workspace_id | str | null | 否 |
workspace_name | str | null | 否 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应:
mailboxes.list
mailboxes.list.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | mailbox.view | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | mailbox.view |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | GET /v1/public/accounts/{account_id}/mailboxes |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
domain | str | null | 否 |
page | int | 否 |
page_size | int | 否 |
search | str | null | 否 |
workspace_id | str | null | 否 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
items | [{"created_at": str, "domain_id": str, "domain_name": str, "first_name": str, "id": str, "last_name": str, "local_part": str, "primary_email": str, "quota": {"allowed": int, "used": int}, "status": str, "updated_at": str, "aliases"?: [{"alias": str, "is_catch_all"?: bool}], "workspace_id"?: str | null, "workspace_name"?: str | null}] | 是 |
page | int | 是 |
page_size | int | 是 |
total | int | 是 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应:
mailboxes.reveal_credentials
mailboxes.reveal_credentials.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | mailbox.credential.reveal | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | mailbox.credential.reveal |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/reveal-credentials |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
mailbox | str | 是 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
password | str | 是 |
username | str | 是 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应:
mailboxes.update
mailboxes.update.
| 属性 | 值 | 属性 | 值 |
|---|---|---|---|
| 所需权限 | mailbox.update | 需要身份验证 | 是 |
| 执行模式 | sync | 能力 | mailbox.update |
| 资源类型 | account | 资源 ID 字段 | account_id |
| 公共 API 路由 | PATCH /v1/public/accounts/{account_id}/mailboxes/{mailbox} |
参数
参数
| 名称 | 类型 | 必需 |
|---|---|---|
account_id | str | 是 |
mailbox | str | 是 |
first_name | str | null | 否 |
last_name | str | null | 否 |
返回值
返回值
| 字段 | 类型 | 必需 |
|---|---|---|
created_at | str | 是 |
domain_id | str | 是 |
domain_name | str | 是 |
first_name | str | 是 |
id | str | 是 |
last_name | str | 是 |
local_part | str | 是 |
primary_email | str | 是 |
quota | {"allowed": int, "used": int} | 是 |
status | str | 是 |
updated_at | str | 是 |
aliases | [{"alias": str, "is_catch_all"?: bool}] | 否 |
workspace_id | str | null | 否 |
workspace_name | str | null | 否 |
A2A 示例
A2A 示例
请求:响应:
MCP 示例
MCP 示例
请求:响应: