Pular para o conteúdo principal

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.

​
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 ferramenta execute.

​
Funções

​
mailboxes.add

mailboxes.add(account_id: str, domain: str, first_name: str, last_name: str, local_part: str) -> Mailbox
Caixas de correio: mailboxes.add.
PropriedadeValorPropriedadeValor
Permissão necessáriamailbox.createAutenticação obrigatóriasim
Modo de execuçãosyncCapacidademailbox.create
Tipo de recursoaccountCampo de ID do recursoaccount_id
Rota da API públicaPOST /v1/public/accounts/{account_id}/mailboxes
NomeTipoObrigatório
account_idstrsim
domainstrsim
first_namestrsim
last_namestrsim
local_partstrsim
CampoTipoObrigatório
created_atstrsim
domain_idstrsim
domain_namestrsim
first_namestrsim
idstrsim
last_namestrsim
local_partstrsim
primary_emailstrsim
quota{"allowed": int, "used": int}sim
statusstrsim
updated_atstrsim
aliases[{"alias": str, "is_catch_all"?: bool}]não
workspace_idstr | nullnão
workspace_namestr | nullnão
Requisição:
{
  "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>\")"
}
Resposta:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.add",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Requisição:
{
  "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>\")"
    }
  }
}
Resposta:
{
  "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
Caixas de correio: mailboxes.aliases.create.
PropriedadeValorPropriedadeValor
Permissão necessáriamailbox.alias.manageAutenticação obrigatóriasim
Modo de execuçãosyncCapacidademailbox.alias.manage
Tipo de recursoaccountCampo de ID do recursoaccount_id
Rota da API públicaPOST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases
NomeTipoObrigatório
account_idstrsim
mailboxstrsim
aliasstrsim
is_catch_allboolnão
CampoTipoObrigatório
aliasstrsim
is_catch_allboolnão
Requisição:
{
  "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)"
}
Resposta:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.aliases.create",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Requisição:
{
  "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)"
    }
  }
}
Resposta:
{
  "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) -> {}
Caixas de correio: mailboxes.aliases.delete.
PropriedadeValorPropriedadeValor
Permissão necessáriamailbox.alias.manageAutenticação obrigatóriasim
Modo de execuçãosyncCapacidademailbox.alias.manage
Tipo de recursoaccountCampo de ID do recursoaccount_id
Rota da API públicaDELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases/{alias}
NomeTipoObrigatório
account_idstrsim
aliasstrsim
mailboxstrsim
CampoTipoObrigatório
result{}sim
Requisição:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.aliases.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", alias=\"<string>\", mailbox=\"<string>\")"
}
Resposta:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.aliases.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Requisição:
{
  "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>\")"
    }
  }
}
Resposta:
{
  "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
Caixas de correio: mailboxes.bulk_add.
PropriedadeValorPropriedadeValor
Permissão necessáriamailbox.createAutenticação obrigatóriasim
Modo de execuçãosyncCapacidademailbox.create
Tipo de recursoaccountCampo de ID do recursoaccount_id
Rota da API públicaPOST /v1/public/accounts/{account_id}/mailboxes/bulk
NomeTipoObrigatório
account_idstrsim
domainstrsim
items[{"first_name": str, "last_name": str, "local_part": str}]sim
CampoTipoObrigató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
Requisição:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.bulk_add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain=\"example.com\", items=\"<string>\")"
}
Resposta:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.bulk_add",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Requisição:
{
  "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>\")"
    }
  }
}
Resposta:
{
  "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
Caixas de correio: mailboxes.get.
PropriedadeValorPropriedadeValor
Permissão necessáriamailbox.viewAutenticação obrigatóriasim
Modo de execuçãosyncCapacidademailbox.view
Tipo de recursoaccountCampo de ID do recursoaccount_id
Rota da API públicaGET /v1/public/accounts/{account_id}/mailboxes/{mailbox}
NomeTipoObrigatório
account_idstrsim
mailboxstrsim
CampoTipoObrigatório
created_atstrsim
domain_idstrsim
domain_namestrsim
first_namestrsim
idstrsim
last_namestrsim
local_partstrsim
primary_emailstrsim
quota{"allowed": int, "used": int}sim
statusstrsim
updated_atstrsim
aliases[{"alias": str, "is_catch_all"?: bool}]não
workspace_idstr | nullnão
workspace_namestr | nullnão
Requisição:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\")"
}
Resposta:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.get",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Requisição:
{
  "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>\")"
    }
  }
}
Resposta:
{
  "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]
Caixas de correio: mailboxes.list.
PropriedadeValorPropriedadeValor
Permissão necessáriamailbox.viewAutenticação obrigatóriasim
Modo de execuçãosyncCapacidademailbox.view
Tipo de recursoaccountCampo de ID do recursoaccount_id
Rota da API públicaGET /v1/public/accounts/{account_id}/mailboxes
NomeTipoObrigatório
account_idstrsim
domainstr | nullnão
pageintnão
page_sizeintnão
searchstr | nullnão
workspace_idstr | nullnão
CampoTipoObrigató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
pageintsim
page_sizeintsim
totalintsim
Requisição:
{
  "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\")"
}
Resposta:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.list",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Requisição:
{
  "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\")"
    }
  }
}
Resposta:
{
  "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
Caixas de correio: mailboxes.reveal_credentials.
PropriedadeValorPropriedadeValor
Permissão necessáriamailbox.credential.revealAutenticação obrigatóriasim
Modo de execuçãosyncCapacidademailbox.credential.reveal
Tipo de recursoaccountCampo de ID do recursoaccount_id
Rota da API públicaPOST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/reveal-credentials
NomeTipoObrigatório
account_idstrsim
mailboxstrsim
CampoTipoObrigatório
passwordstrsim
usernamestrsim
Requisição:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.reveal_credentials(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\")"
}
Resposta:
{
  "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
}
Requisição:
{
  "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>\")"
    }
  }
}
Resposta:
{
  "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
Caixas de correio: mailboxes.update.
PropriedadeValorPropriedadeValor
Permissão necessáriamailbox.updateAutenticação obrigatóriasim
Modo de execuçãosyncCapacidademailbox.update
Tipo de recursoaccountCampo de ID do recursoaccount_id
Rota da API públicaPATCH /v1/public/accounts/{account_id}/mailboxes/{mailbox}
NomeTipoObrigatório
account_idstrsim
mailboxstrsim
first_namestr | nullnão
last_namestr | nullnão
CampoTipoObrigatório
created_atstrsim
domain_idstrsim
domain_namestrsim
first_namestrsim
idstrsim
last_namestrsim
local_partstrsim
primary_emailstrsim
quota{"allowed": int, "used": int}sim
statusstrsim
updated_atstrsim
aliases[{"alias": str, "is_catch_all"?: bool}]não
workspace_idstr | nullnão
workspace_namestr | nullnão
Requisição:
{
  "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>\")"
}
Resposta:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.update",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Requisição:
{
  "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>\")"
    }
  }
}
Resposta:
{
  "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
  }
}