Passer au contenu 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.

​
Boîtes aux lettres

Gérer les boîtes SMTP, les identifiants et les domaines de boîte. Les exemples utilisent le mode code A2A. MCP expose le même mode code via son outil execute.

​
Fonctions

​
mailboxes.add

mailboxes.add(account_id: str, domain: str, first_name: str, last_name: str, local_part: str) -> Mailbox
Boîtes aux lettres: mailboxes.add.
PropriétéValeurPropriétéValeur
Autorisation requisemailbox.createAuthentification requiseoui
Mode d’exécutionsyncCapacitémailbox.create
Type de ressourceaccountChamp d’ID de ressourceaccount_id
Route API publiquePOST /v1/public/accounts/{account_id}/mailboxes
NomTypeRequis
account_idstroui
domainstroui
first_namestroui
last_namestroui
local_partstroui
ChampTypeRequis
created_atstroui
domain_idstroui
domain_namestroui
first_namestroui
idstroui
last_namestroui
local_partstroui
primary_emailstroui
quota{"allowed": int, "used": int}oui
statusstroui
updated_atstroui
aliases[{"alias": str, "is_catch_all"?: bool}]non
workspace_idstr | nullnon
workspace_namestr | nullnon
Requête:
{
  "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>\")"
}
Réponse:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.add",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Requête:
{
  "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>\")"
    }
  }
}
Réponse:
{
  "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
Boîtes aux lettres: mailboxes.aliases.create.
PropriétéValeurPropriétéValeur
Autorisation requisemailbox.alias.manageAuthentification requiseoui
Mode d’exécutionsyncCapacitémailbox.alias.manage
Type de ressourceaccountChamp d’ID de ressourceaccount_id
Route API publiquePOST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases
NomTypeRequis
account_idstroui
mailboxstroui
aliasstroui
is_catch_allboolnon
ChampTypeRequis
aliasstroui
is_catch_allboolnon
Requête:
{
  "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)"
}
Réponse:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.aliases.create",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Requête:
{
  "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)"
    }
  }
}
Réponse:
{
  "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) -> {}
Boîtes aux lettres: mailboxes.aliases.delete.
PropriétéValeurPropriétéValeur
Autorisation requisemailbox.alias.manageAuthentification requiseoui
Mode d’exécutionsyncCapacitémailbox.alias.manage
Type de ressourceaccountChamp d’ID de ressourceaccount_id
Route API publiqueDELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases/{alias}
NomTypeRequis
account_idstroui
aliasstroui
mailboxstroui
ChampTypeRequis
result{}oui
Requête:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.aliases.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", alias=\"<string>\", mailbox=\"<string>\")"
}
Réponse:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.aliases.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Requête:
{
  "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>\")"
    }
  }
}
Réponse:
{
  "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
Boîtes aux lettres: mailboxes.bulk_add.
PropriétéValeurPropriétéValeur
Autorisation requisemailbox.createAuthentification requiseoui
Mode d’exécutionsyncCapacitémailbox.create
Type de ressourceaccountChamp d’ID de ressourceaccount_id
Route API publiquePOST /v1/public/accounts/{account_id}/mailboxes/bulk
NomTypeRequis
account_idstroui
domainstroui
items[{"first_name": str, "last_name": str, "local_part": str}]oui
ChampTypeRequis
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}}]oui
failed[{"code": str, "index": int, "message": str}]oui
Requête:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.bulk_add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain=\"example.com\", items=\"<string>\")"
}
Réponse:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.bulk_add",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Requête:
{
  "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>\")"
    }
  }
}
Réponse:
{
  "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
Boîtes aux lettres: mailboxes.get.
PropriétéValeurPropriétéValeur
Autorisation requisemailbox.viewAuthentification requiseoui
Mode d’exécutionsyncCapacitémailbox.view
Type de ressourceaccountChamp d’ID de ressourceaccount_id
Route API publiqueGET /v1/public/accounts/{account_id}/mailboxes/{mailbox}
NomTypeRequis
account_idstroui
mailboxstroui
ChampTypeRequis
created_atstroui
domain_idstroui
domain_namestroui
first_namestroui
idstroui
last_namestroui
local_partstroui
primary_emailstroui
quota{"allowed": int, "used": int}oui
statusstroui
updated_atstroui
aliases[{"alias": str, "is_catch_all"?: bool}]non
workspace_idstr | nullnon
workspace_namestr | nullnon
Requête:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\")"
}
Réponse:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.get",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Requête:
{
  "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>\")"
    }
  }
}
Réponse:
{
  "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]
Boîtes aux lettres: mailboxes.list.
PropriétéValeurPropriétéValeur
Autorisation requisemailbox.viewAuthentification requiseoui
Mode d’exécutionsyncCapacitémailbox.view
Type de ressourceaccountChamp d’ID de ressourceaccount_id
Route API publiqueGET /v1/public/accounts/{account_id}/mailboxes
NomTypeRequis
account_idstroui
domainstr | nullnon
pageintnon
page_sizeintnon
searchstr | nullnon
workspace_idstr | nullnon
ChampTypeRequis
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}]oui
pageintoui
page_sizeintoui
totalintoui
Requête:
{
  "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\")"
}
Réponse:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.list",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Requête:
{
  "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\")"
    }
  }
}
Réponse:
{
  "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
Boîtes aux lettres: mailboxes.reveal_credentials.
PropriétéValeurPropriétéValeur
Autorisation requisemailbox.credential.revealAuthentification requiseoui
Mode d’exécutionsyncCapacitémailbox.credential.reveal
Type de ressourceaccountChamp d’ID de ressourceaccount_id
Route API publiquePOST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/reveal-credentials
NomTypeRequis
account_idstroui
mailboxstroui
ChampTypeRequis
passwordstroui
usernamestroui
Requête:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.reveal_credentials(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\")"
}
Réponse:
{
  "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
}
Requête:
{
  "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>\")"
    }
  }
}
Réponse:
{
  "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
Boîtes aux lettres: mailboxes.update.
PropriétéValeurPropriétéValeur
Autorisation requisemailbox.updateAuthentification requiseoui
Mode d’exécutionsyncCapacitémailbox.update
Type de ressourceaccountChamp d’ID de ressourceaccount_id
Route API publiquePATCH /v1/public/accounts/{account_id}/mailboxes/{mailbox}
NomTypeRequis
account_idstroui
mailboxstroui
first_namestr | nullnon
last_namestr | nullnon
ChampTypeRequis
created_atstroui
domain_idstroui
domain_namestroui
first_namestroui
idstroui
last_namestroui
local_partstroui
primary_emailstroui
quota{"allowed": int, "used": int}oui
statusstroui
updated_atstroui
aliases[{"alias": str, "is_catch_all"?: bool}]non
workspace_idstr | nullnon
workspace_namestr | nullnon
Requête:
{
  "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>\")"
}
Réponse:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.update",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Requête:
{
  "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>\")"
    }
  }
}
Réponse:
{
  "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
  }
}