Перейти к основному содержанию

Documentation Index

Fetch the complete documentation index at: https://docs.hybridbox.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Почтовые ящики

Управлять SMTP-почтовыми ящиками, учетными данными и доменами ящиков. В примерах используется режим кода A2A. MCP предоставляет тот же режим кода через инструмент execute.

​
Функции

​
mailboxes.add

mailboxes.add(account_id: str, domain: str, first_name: str, last_name: str, local_part: str) -> Mailbox
Почтовые ящики: mailboxes.add.
СвойствоЗначениеСвойствоЗначение
Требуемое разрешениеmailbox.createТребуется аутентификацияда
Режим выполненияsyncВозможностьmailbox.create
Тип ресурсаaccountПоле ID ресурсаaccount_id
Публичный маршрут APIPOST /v1/public/accounts/{account_id}/mailboxes
ИмяТипОбязательный
account_idstrда
domainstrда
first_namestrда
last_namestrда
local_partstrда
ПолеТипОбязательный
created_atstrда
domain_idstrда
domain_namestrда
first_namestrда
idstrда
last_namestrда
local_partstrда
primary_emailstrда
quota{"allowed": int, "used": int}да
statusstrда
updated_atstrда
aliases[{"alias": str, "is_catch_all"?: bool}]нет
workspace_idstr | nullнет
workspace_namestr | nullнет
Запрос:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain=\"example.com\", first_name=\"<string>\", last_name=\"<string>\", local_part=\"<string>\")"
}
Ответ:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.add",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Запрос:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "mailboxes.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain=\"example.com\", first_name=\"<string>\", last_name=\"<string>\", local_part=\"<string>\")"
    }
  }
}
Ответ:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"mailboxes.add\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
mailboxes.aliases.create

mailboxes.aliases.create(account_id: str, mailbox: str, alias: str, is_catch_all?: bool) -> Mailbox
Почтовые ящики: mailboxes.aliases.create.
СвойствоЗначениеСвойствоЗначение
Требуемое разрешениеmailbox.alias.manageТребуется аутентификацияда
Режим выполненияsyncВозможностьmailbox.alias.manage
Тип ресурсаaccountПоле ID ресурсаaccount_id
Публичный маршрут APIPOST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases
ИмяТипОбязательный
account_idstrда
mailboxstrда
aliasstrда
is_catch_allboolнет
ПолеТипОбязательный
aliasstrда
is_catch_allboolнет
Запрос:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.aliases.create(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\", alias=\"<string>\", is_catch_all=true)"
}
Ответ:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.aliases.create",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Запрос:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "mailboxes.aliases.create(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\", alias=\"<string>\", is_catch_all=true)"
    }
  }
}
Ответ:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": true\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"mailboxes.aliases.create\",\n      \"status\": \"completed\",\n      \"result\": true\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
mailboxes.aliases.delete

mailboxes.aliases.delete(account_id: str, alias: str, mailbox: str) -> {}
Почтовые ящики: mailboxes.aliases.delete.
СвойствоЗначениеСвойствоЗначение
Требуемое разрешениеmailbox.alias.manageТребуется аутентификацияда
Режим выполненияsyncВозможностьmailbox.alias.manage
Тип ресурсаaccountПоле ID ресурсаaccount_id
Публичный маршрут APIDELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases/{alias}
ИмяТипОбязательный
account_idstrда
aliasstrда
mailboxstrда
ПолеТипОбязательный
result{}да
Запрос:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.aliases.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", alias=\"<string>\", mailbox=\"<string>\")"
}
Ответ:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.aliases.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Запрос:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "mailboxes.aliases.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", alias=\"<string>\", mailbox=\"<string>\")"
    }
  }
}
Ответ:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {}\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"mailboxes.aliases.delete\",\n      \"status\": \"completed\",\n      \"result\": {}\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
mailboxes.bulk_add

mailboxes.bulk_add(account_id: str, domain: str, items: [{"first_name": str, "last_name": str, "local_part": str}]) -> Mailbox
Почтовые ящики: mailboxes.bulk_add.
СвойствоЗначениеСвойствоЗначение
Требуемое разрешениеmailbox.createТребуется аутентификацияда
Режим выполненияsyncВозможностьmailbox.create
Тип ресурсаaccountПоле ID ресурсаaccount_id
Публичный маршрут APIPOST /v1/public/accounts/{account_id}/mailboxes/bulk
ИмяТипОбязательный
account_idstrда
domainstrда
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}]да
Запрос:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.bulk_add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain=\"example.com\", items=\"<string>\")"
}
Ответ:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.bulk_add",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Запрос:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "mailboxes.bulk_add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain=\"example.com\", items=\"<string>\")"
    }
  }
}
Ответ:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"mailboxes.bulk_add\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
mailboxes.get

mailboxes.get(account_id: str, mailbox: str) -> Mailbox
Почтовые ящики: mailboxes.get.
СвойствоЗначениеСвойствоЗначение
Требуемое разрешениеmailbox.viewТребуется аутентификацияда
Режим выполненияsyncВозможностьmailbox.view
Тип ресурсаaccountПоле ID ресурсаaccount_id
Публичный маршрут APIGET /v1/public/accounts/{account_id}/mailboxes/{mailbox}
ИмяТипОбязательный
account_idstrда
mailboxstrда
ПолеТипОбязательный
created_atstrда
domain_idstrда
domain_namestrда
first_namestrда
idstrда
last_namestrда
local_partstrда
primary_emailstrда
quota{"allowed": int, "used": int}да
statusstrда
updated_atstrда
aliases[{"alias": str, "is_catch_all"?: bool}]нет
workspace_idstr | nullнет
workspace_namestr | nullнет
Запрос:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\")"
}
Ответ:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.get",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Запрос:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "mailboxes.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\")"
    }
  }
}
Ответ:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"mailboxes.get\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
mailboxes.list

mailboxes.list(account_id: str, domain?: str | null, page?: int, page_size?: int, search?: str | null, workspace_id?: str | null) -> Page[Mailbox]
Почтовые ящики: mailboxes.list.
СвойствоЗначениеСвойствоЗначение
Требуемое разрешениеmailbox.viewТребуется аутентификацияда
Режим выполненияsyncВозможностьmailbox.view
Тип ресурсаaccountПоле ID ресурсаaccount_id
Публичный маршрут APIGET /v1/public/accounts/{account_id}/mailboxes
ИмяТипОбязательный
account_idstrда
domainstr | nullнет
pageintнет
page_sizeintнет
searchstr | nullнет
workspace_idstr | 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}]да
pageintда
page_sizeintда
totalintда
Запрос:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain=\"example.com\", page=123, page_size=123, search=\"<string>\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Ответ:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.list",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Запрос:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "mailboxes.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain=\"example.com\", page=123, page_size=123, search=\"<string>\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
  }
}
Ответ:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"mailboxes.list\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
mailboxes.reveal_credentials

mailboxes.reveal_credentials(account_id: str, mailbox: str) -> Mailbox
Почтовые ящики: mailboxes.reveal_credentials.
СвойствоЗначениеСвойствоЗначение
Требуемое разрешениеmailbox.credential.revealТребуется аутентификацияда
Режим выполненияsyncВозможностьmailbox.credential.reveal
Тип ресурсаaccountПоле ID ресурсаaccount_id
Публичный маршрут APIPOST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/reveal-credentials
ИмяТипОбязательный
account_idstrда
mailboxstrда
ПолеТипОбязательный
passwordstrда
usernamestrда
Запрос:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.reveal_credentials(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\")"
}
Ответ:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {
      "password": "<string>",
      "username": "<string>"
    }
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.reveal_credentials",
      "status": "completed",
      "result": {
        "password": "<string>",
        "username": "<string>"
      }
    }
  ],
  "complexity_score": 1
}
Запрос:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "mailboxes.reveal_credentials(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\")"
    }
  }
}
Ответ:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {\n      \"password\": \"<string>\",\n      \"username\": \"<string>\"\n    }\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"mailboxes.reveal_credentials\",\n      \"status\": \"completed\",\n      \"result\": {\n        \"password\": \"<string>\",\n        \"username\": \"<string>\"\n      }\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

​
mailboxes.update

mailboxes.update(account_id: str, mailbox: str, first_name?: str | null, last_name?: str | null) -> Mailbox
Почтовые ящики: mailboxes.update.
СвойствоЗначениеСвойствоЗначение
Требуемое разрешениеmailbox.updateТребуется аутентификацияда
Режим выполненияsyncВозможностьmailbox.update
Тип ресурсаaccountПоле ID ресурсаaccount_id
Публичный маршрут APIPATCH /v1/public/accounts/{account_id}/mailboxes/{mailbox}
ИмяТипОбязательный
account_idstrда
mailboxstrда
first_namestr | nullнет
last_namestr | nullнет
ПолеТипОбязательный
created_atstrда
domain_idstrда
domain_namestrда
first_namestrда
idstrда
last_namestrда
local_partstrда
primary_emailstrда
quota{"allowed": int, "used": int}да
statusstrда
updated_atstrда
aliases[{"alias": str, "is_catch_all"?: bool}]нет
workspace_idstr | nullнет
workspace_namestr | nullнет
Запрос:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\", first_name=\"<string>\", last_name=\"<string>\")"
}
Ответ:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.update",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Запрос:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "mailboxes.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\", first_name=\"<string>\", last_name=\"<string>\")"
    }
  }
}
Ответ:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"mailboxes.update\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}