> ## 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.
# Caselle postali
> Gestire caselle SMTP, credenziali e domini delle caselle.
# Caselle postali
Gestire caselle SMTP, credenziali e domini delle caselle.
Gli esempi usano la modalità codice A2A. MCP espone la stessa modalità codice tramite lo strumento `execute`.
## Funzioni
### `mailboxes.add`
```text theme={null}
mailboxes.add(account_id: str, domain: str, first_name: str, last_name: str, local_part: str) -> Mailbox
```
Caselle postali: `mailboxes.add`.
| Proprietà | Valore | Proprietà | Valore |
| ------------------------ | ------------------------------------------------- | ------------------------ | ---------------- |
| Autorizzazione richiesta | `mailbox.create` | Autenticazione richiesta | `sì` |
| Modalità di esecuzione | `sync` | Capacità | `mailbox.create` |
| Tipo di risorsa | `account` | Campo ID risorsa | `account_id` |
| Route API pubblica | `POST /v1/public/accounts/{account_id}/mailboxes` | | |
| Nome | Tipo | Obbligatorio |
| ------------ | ----- | ------------ |
| `account_id` | `str` | sì |
| `domain` | `str` | sì |
| `first_name` | `str` | sì |
| `last_name` | `str` | sì |
| `local_part` | `str` | sì |
| Campo | Tipo | Obbligatorio |
| ---------------- | ----------------------------------------- | ------------ |
| `created_at` | `str` | sì |
| `domain_id` | `str` | sì |
| `domain_name` | `str` | sì |
| `first_name` | `str` | sì |
| `id` | `str` | sì |
| `last_name` | `str` | sì |
| `local_part` | `str` | sì |
| `primary_email` | `str` | sì |
| `quota` | `{"allowed": int, "used": int}` | sì |
| `status` | `str` | sì |
| `updated_at` | `str` | sì |
| `aliases` | `[{"alias": str, "is_catch_all"?: bool}]` | no |
| `workspace_id` | `str \| null` | no |
| `workspace_name` | `str \| null` | no |
Richiesta:
```json theme={null}
{
"request_id": "example",
"session_id": "session_123",
"code": "mailboxes.add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain=\"example.com\", first_name=\"\", last_name=\"\", local_part=\"\")"
}
```
Risposta:
```json theme={null}
{
"request_id": "example",
"status": "completed",
"result": {
"last_value": 123
},
"responses": [
{
"index": 0,
"function": "mailboxes.add",
"status": "completed",
"result": 123
}
],
"complexity_score": 1
}
```
Richiesta:
```json theme={null}
{
"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=\"\", last_name=\"\", local_part=\"\")"
}
}
}
```
Risposta:
```json theme={null}
{
"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`
```text theme={null}
mailboxes.aliases.create(account_id: str, mailbox: str, alias: str, is_catch_all?: bool) -> Mailbox
```
Caselle postali: `mailboxes.aliases.create`.
| Proprietà | Valore | Proprietà | Valore |
| ------------------------ | ------------------------------------------------------------------- | ------------------------ | ---------------------- |
| Autorizzazione richiesta | `mailbox.alias.manage` | Autenticazione richiesta | `sì` |
| Modalità di esecuzione | `sync` | Capacità | `mailbox.alias.manage` |
| Tipo di risorsa | `account` | Campo ID risorsa | `account_id` |
| Route API pubblica | `POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases` | | |
| Nome | Tipo | Obbligatorio |
| -------------- | ------ | ------------ |
| `account_id` | `str` | sì |
| `mailbox` | `str` | sì |
| `alias` | `str` | sì |
| `is_catch_all` | `bool` | no |
| Campo | Tipo | Obbligatorio |
| -------------- | ------ | ------------ |
| `alias` | `str` | sì |
| `is_catch_all` | `bool` | no |
Richiesta:
```json theme={null}
{
"request_id": "example",
"session_id": "session_123",
"code": "mailboxes.aliases.create(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"\", alias=\"\", is_catch_all=true)"
}
```
Risposta:
```json theme={null}
{
"request_id": "example",
"status": "completed",
"result": {
"last_value": true
},
"responses": [
{
"index": 0,
"function": "mailboxes.aliases.create",
"status": "completed",
"result": true
}
],
"complexity_score": 1
}
```
Richiesta:
```json theme={null}
{
"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=\"\", alias=\"\", is_catch_all=true)"
}
}
}
```
Risposta:
```json theme={null}
{
"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`
```text theme={null}
mailboxes.aliases.delete(account_id: str, alias: str, mailbox: str) -> {}
```
Caselle postali: `mailboxes.aliases.delete`.
| Proprietà | Valore | Proprietà | Valore |
| ------------------------ | ----------------------------------------------------------------------------- | ------------------------ | ---------------------- |
| Autorizzazione richiesta | `mailbox.alias.manage` | Autenticazione richiesta | `sì` |
| Modalità di esecuzione | `sync` | Capacità | `mailbox.alias.manage` |
| Tipo di risorsa | `account` | Campo ID risorsa | `account_id` |
| Route API pubblica | `DELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases/{alias}` | | |
| Nome | Tipo | Obbligatorio |
| ------------ | ----- | ------------ |
| `account_id` | `str` | sì |
| `alias` | `str` | sì |
| `mailbox` | `str` | sì |
| Campo | Tipo | Obbligatorio |
| -------- | ---- | ------------ |
| `result` | `{}` | sì |
Richiesta:
```json theme={null}
{
"request_id": "example",
"session_id": "session_123",
"code": "mailboxes.aliases.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", alias=\"\", mailbox=\"\")"
}
```
Risposta:
```json theme={null}
{
"request_id": "example",
"status": "completed",
"result": {
"last_value": {}
},
"responses": [
{
"index": 0,
"function": "mailboxes.aliases.delete",
"status": "completed",
"result": {}
}
],
"complexity_score": 1
}
```
Richiesta:
```json theme={null}
{
"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=\"\", mailbox=\"\")"
}
}
}
```
Risposta:
```json theme={null}
{
"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`
```text theme={null}
mailboxes.bulk_add(account_id: str, domain: str, items: [{"first_name": str, "last_name": str, "local_part": str}]) -> Mailbox
```
Caselle postali: `mailboxes.bulk_add`.
| Proprietà | Valore | Proprietà | Valore |
| ------------------------ | ------------------------------------------------------ | ------------------------ | ---------------- |
| Autorizzazione richiesta | `mailbox.create` | Autenticazione richiesta | `sì` |
| Modalità di esecuzione | `sync` | Capacità | `mailbox.create` |
| Tipo di risorsa | `account` | Campo ID risorsa | `account_id` |
| Route API pubblica | `POST /v1/public/accounts/{account_id}/mailboxes/bulk` | | |
| Nome | Tipo | Obbligatorio |
| ------------ | ------------------------------------------------------------ | ------------ |
| `account_id` | `str` | sì |
| `domain` | `str` | sì |
| `items` | `[{"first_name": str, "last_name": str, "local_part": str}]` | sì |
| Campo | Tipo | Obbligatorio |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------ |
| `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}}]` | sì |
| `failed` | `[{"code": str, "index": int, "message": str}]` | sì |
Richiesta:
```json theme={null}
{
"request_id": "example",
"session_id": "session_123",
"code": "mailboxes.bulk_add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain=\"example.com\", items=\"\")"
}
```
Risposta:
```json theme={null}
{
"request_id": "example",
"status": "completed",
"result": {
"last_value": 123
},
"responses": [
{
"index": 0,
"function": "mailboxes.bulk_add",
"status": "completed",
"result": 123
}
],
"complexity_score": 1
}
```
Richiesta:
```json theme={null}
{
"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=\"\")"
}
}
}
```
Risposta:
```json theme={null}
{
"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`
```text theme={null}
mailboxes.get(account_id: str, mailbox: str) -> Mailbox
```
Caselle postali: `mailboxes.get`.
| Proprietà | Valore | Proprietà | Valore |
| ------------------------ | ---------------------------------------------------------- | ------------------------ | -------------- |
| Autorizzazione richiesta | `mailbox.view` | Autenticazione richiesta | `sì` |
| Modalità di esecuzione | `sync` | Capacità | `mailbox.view` |
| Tipo di risorsa | `account` | Campo ID risorsa | `account_id` |
| Route API pubblica | `GET /v1/public/accounts/{account_id}/mailboxes/{mailbox}` | | |
| Nome | Tipo | Obbligatorio |
| ------------ | ----- | ------------ |
| `account_id` | `str` | sì |
| `mailbox` | `str` | sì |
| Campo | Tipo | Obbligatorio |
| ---------------- | ----------------------------------------- | ------------ |
| `created_at` | `str` | sì |
| `domain_id` | `str` | sì |
| `domain_name` | `str` | sì |
| `first_name` | `str` | sì |
| `id` | `str` | sì |
| `last_name` | `str` | sì |
| `local_part` | `str` | sì |
| `primary_email` | `str` | sì |
| `quota` | `{"allowed": int, "used": int}` | sì |
| `status` | `str` | sì |
| `updated_at` | `str` | sì |
| `aliases` | `[{"alias": str, "is_catch_all"?: bool}]` | no |
| `workspace_id` | `str \| null` | no |
| `workspace_name` | `str \| null` | no |
Richiesta:
```json theme={null}
{
"request_id": "example",
"session_id": "session_123",
"code": "mailboxes.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"\")"
}
```
Risposta:
```json theme={null}
{
"request_id": "example",
"status": "completed",
"result": {
"last_value": 123
},
"responses": [
{
"index": 0,
"function": "mailboxes.get",
"status": "completed",
"result": 123
}
],
"complexity_score": 1
}
```
Richiesta:
```json theme={null}
{
"jsonrpc": "2.0",
"id": "example",
"method": "tools/call",
"params": {
"name": "hybridbox_execute",
"arguments": {
"code": "mailboxes.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"\")"
}
}
}
```
Risposta:
```json theme={null}
{
"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`
```text theme={null}
mailboxes.list(account_id: str, domain?: str | null, page?: int, page_size?: int, search?: str | null, workspace_id?: str | null) -> Page[Mailbox]
```
Caselle postali: `mailboxes.list`.
| Proprietà | Valore | Proprietà | Valore |
| ------------------------ | ------------------------------------------------ | ------------------------ | -------------- |
| Autorizzazione richiesta | `mailbox.view` | Autenticazione richiesta | `sì` |
| Modalità di esecuzione | `sync` | Capacità | `mailbox.view` |
| Tipo di risorsa | `account` | Campo ID risorsa | `account_id` |
| Route API pubblica | `GET /v1/public/accounts/{account_id}/mailboxes` | | |
| Nome | Tipo | Obbligatorio |
| -------------- | ------------- | ------------ |
| `account_id` | `str` | sì |
| `domain` | `str \| null` | no |
| `page` | `int` | no |
| `page_size` | `int` | no |
| `search` | `str \| null` | no |
| `workspace_id` | `str \| null` | no |
| Campo | Tipo | Obbligatorio |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| `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}]` | sì |
| `page` | `int` | sì |
| `page_size` | `int` | sì |
| `total` | `int` | sì |
Richiesta:
```json theme={null}
{
"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=\"\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
```
Risposta:
```json theme={null}
{
"request_id": "example",
"status": "completed",
"result": {
"last_value": 123
},
"responses": [
{
"index": 0,
"function": "mailboxes.list",
"status": "completed",
"result": 123
}
],
"complexity_score": 1
}
```
Richiesta:
```json theme={null}
{
"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=\"\", workspace_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
}
}
```
Risposta:
```json theme={null}
{
"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`
```text theme={null}
mailboxes.reveal_credentials(account_id: str, mailbox: str) -> Mailbox
```
Caselle postali: `mailboxes.reveal_credentials`.
| Proprietà | Valore | Proprietà | Valore |
| ------------------------ | ------------------------------------------------------------------------------ | ------------------------ | --------------------------- |
| Autorizzazione richiesta | `mailbox.credential.reveal` | Autenticazione richiesta | `sì` |
| Modalità di esecuzione | `sync` | Capacità | `mailbox.credential.reveal` |
| Tipo di risorsa | `account` | Campo ID risorsa | `account_id` |
| Route API pubblica | `POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/reveal-credentials` | | |
| Nome | Tipo | Obbligatorio |
| ------------ | ----- | ------------ |
| `account_id` | `str` | sì |
| `mailbox` | `str` | sì |
| Campo | Tipo | Obbligatorio |
| ---------- | ----- | ------------ |
| `password` | `str` | sì |
| `username` | `str` | sì |
Richiesta:
```json theme={null}
{
"request_id": "example",
"session_id": "session_123",
"code": "mailboxes.reveal_credentials(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"\")"
}
```
Risposta:
```json theme={null}
{
"request_id": "example",
"status": "completed",
"result": {
"last_value": {
"password": "",
"username": ""
}
},
"responses": [
{
"index": 0,
"function": "mailboxes.reveal_credentials",
"status": "completed",
"result": {
"password": "",
"username": ""
}
}
],
"complexity_score": 1
}
```
Richiesta:
```json theme={null}
{
"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=\"\")"
}
}
}
```
Risposta:
```json theme={null}
{
"jsonrpc": "2.0",
"id": "example",
"result": {
"content": [
{
"type": "text",
"text": "{\n \"request_id\": \"example\",\n \"status\": \"completed\",\n \"result\": {\n \"last_value\": {\n \"password\": \"\",\n \"username\": \"\"\n }\n },\n \"responses\": [\n {\n \"index\": 0,\n \"function\": \"mailboxes.reveal_credentials\",\n \"status\": \"completed\",\n \"result\": {\n \"password\": \"\",\n \"username\": \"\"\n }\n }\n ],\n \"complexity_score\": 1\n}"
}
],
"isError": false
}
}
```
### `mailboxes.update`
```text theme={null}
mailboxes.update(account_id: str, mailbox: str, first_name?: str | null, last_name?: str | null) -> Mailbox
```
Caselle postali: `mailboxes.update`.
| Proprietà | Valore | Proprietà | Valore |
| ------------------------ | ------------------------------------------------------------ | ------------------------ | ---------------- |
| Autorizzazione richiesta | `mailbox.update` | Autenticazione richiesta | `sì` |
| Modalità di esecuzione | `sync` | Capacità | `mailbox.update` |
| Tipo di risorsa | `account` | Campo ID risorsa | `account_id` |
| Route API pubblica | `PATCH /v1/public/accounts/{account_id}/mailboxes/{mailbox}` | | |
| Nome | Tipo | Obbligatorio |
| ------------ | ------------- | ------------ |
| `account_id` | `str` | sì |
| `mailbox` | `str` | sì |
| `first_name` | `str \| null` | no |
| `last_name` | `str \| null` | no |
| Campo | Tipo | Obbligatorio |
| ---------------- | ----------------------------------------- | ------------ |
| `created_at` | `str` | sì |
| `domain_id` | `str` | sì |
| `domain_name` | `str` | sì |
| `first_name` | `str` | sì |
| `id` | `str` | sì |
| `last_name` | `str` | sì |
| `local_part` | `str` | sì |
| `primary_email` | `str` | sì |
| `quota` | `{"allowed": int, "used": int}` | sì |
| `status` | `str` | sì |
| `updated_at` | `str` | sì |
| `aliases` | `[{"alias": str, "is_catch_all"?: bool}]` | no |
| `workspace_id` | `str \| null` | no |
| `workspace_name` | `str \| null` | no |
Richiesta:
```json theme={null}
{
"request_id": "example",
"session_id": "session_123",
"code": "mailboxes.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"\", first_name=\"\", last_name=\"\")"
}
```
Risposta:
```json theme={null}
{
"request_id": "example",
"status": "completed",
"result": {
"last_value": 123
},
"responses": [
{
"index": 0,
"function": "mailboxes.update",
"status": "completed",
"result": 123
}
],
"complexity_score": 1
}
```
Richiesta:
```json theme={null}
{
"jsonrpc": "2.0",
"id": "example",
"method": "tools/call",
"params": {
"name": "hybridbox_execute",
"arguments": {
"code": "mailboxes.update(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"\", first_name=\"\", last_name=\"\")"
}
}
}
```
Risposta:
```json theme={null}
{
"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
}
}
```