Caixas de correio
Gerenciar caixas SMTP, credenciais e domínios de caixa. Os exemplos usam o modo de código A2A. O MCP expõe o mesmo modo de código pela ferramentaexecute.
Funções
mailboxes.add
mailboxes.add.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | mailbox.create | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | mailbox.create |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/mailboxes |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
domain | str | sim |
first_name | str | sim |
last_name | str | sim |
local_part | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
created_at | str | sim |
domain_id | str | sim |
domain_name | str | sim |
first_name | str | sim |
id | str | sim |
last_name | str | sim |
local_part | str | sim |
primary_email | str | sim |
quota | {"allowed": int, "used": int} | sim |
status | str | sim |
updated_at | str | sim |
aliases | [{"alias": str, "is_catch_all"?: bool}] | não |
workspace_id | str | null | não |
workspace_name | str | null | não |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta:
mailboxes.aliases.create
mailboxes.aliases.create.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | mailbox.alias.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | mailbox.alias.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
mailbox | str | sim |
alias | str | sim |
is_catch_all | bool | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
alias | str | sim |
is_catch_all | bool | não |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta:
mailboxes.aliases.delete
mailboxes.aliases.delete.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | mailbox.alias.manage | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | mailbox.alias.manage |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | DELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases/{alias} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
alias | str | sim |
mailbox | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
result | {} | sim |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta:
mailboxes.bulk_add
mailboxes.bulk_add.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | mailbox.create | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | mailbox.create |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/mailboxes/bulk |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
domain | str | sim |
items | [{"first_name": str, "last_name": str, "local_part": str}] | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
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}}] | sim |
failed | [{"code": str, "index": int, "message": str}] | sim |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta:
mailboxes.get
mailboxes.get.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | mailbox.view | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | mailbox.view |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | GET /v1/public/accounts/{account_id}/mailboxes/{mailbox} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
mailbox | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
created_at | str | sim |
domain_id | str | sim |
domain_name | str | sim |
first_name | str | sim |
id | str | sim |
last_name | str | sim |
local_part | str | sim |
primary_email | str | sim |
quota | {"allowed": int, "used": int} | sim |
status | str | sim |
updated_at | str | sim |
aliases | [{"alias": str, "is_catch_all"?: bool}] | não |
workspace_id | str | null | não |
workspace_name | str | null | não |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta:
mailboxes.list
mailboxes.list.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | mailbox.view | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | mailbox.view |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | GET /v1/public/accounts/{account_id}/mailboxes |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
domain | str | null | não |
page | int | não |
page_size | int | não |
search | str | null | não |
workspace_id | str | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
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}] | sim |
page | int | sim |
page_size | int | sim |
total | int | sim |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta:
mailboxes.reveal_credentials
mailboxes.reveal_credentials.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | mailbox.credential.reveal | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | mailbox.credential.reveal |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/reveal-credentials |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
mailbox | str | sim |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
password | str | sim |
username | str | sim |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta:
mailboxes.update
mailboxes.update.
| Propriedade | Valor | Propriedade | Valor |
|---|---|---|---|
| Permissão necessária | mailbox.update | Autenticação obrigatória | sim |
| Modo de execução | sync | Capacidade | mailbox.update |
| Tipo de recurso | account | Campo de ID do recurso | account_id |
| Rota da API pública | PATCH /v1/public/accounts/{account_id}/mailboxes/{mailbox} |
Argumentos
Argumentos
| Nome | Tipo | Obrigatório |
|---|---|---|
account_id | str | sim |
mailbox | str | sim |
first_name | str | null | não |
last_name | str | null | não |
Retorna
Retorna
| Campo | Tipo | Obrigatório |
|---|---|---|
created_at | str | sim |
domain_id | str | sim |
domain_name | str | sim |
first_name | str | sim |
id | str | sim |
last_name | str | sim |
local_part | str | sim |
primary_email | str | sim |
quota | {"allowed": int, "used": int} | sim |
status | str | sim |
updated_at | str | sim |
aliases | [{"alias": str, "is_catch_all"?: bool}] | não |
workspace_id | str | null | não |
workspace_name | str | null | não |
Exemplo A2A
Exemplo A2A
Requisição:Resposta:
Exemplo MCP
Exemplo MCP
Requisição:Resposta: