Почтовые ящики
Управлять 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
Запрос:Ответ: