Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hybridbox.mintlify.app/llms.txt

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

​
Mailboxes

Manage SMTP mailboxes, credentials, and mailbox domains. The examples use A2A code mode. MCP exposes the same code mode through its execute tool.

​
Functions

​
mailboxes.add

mailboxes.add(account_id: str, domain: str, first_name: str, last_name: str, local_part: str) -> Mailbox
Create mailboxes.
PropertyValuePropertyValue
Requires permissionmailbox.createAuth requiredyes
Execution modesyncCapabilitymailbox.create
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/mailboxes
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
domainstryesDomain UUID or domain name for the mailbox
first_namestryes
last_namestryes
local_partstryes
FieldTypeRequiredDescription
created_atstryesMailbox creation timestamp
domain_idstryesDomain UUID for the mailbox
domain_namestryesDomain name for the mailbox
first_namestryesMailbox user first name
idstryesMailbox UUID
last_namestryesMailbox user last name
local_partstryesMailbox local part before the at sign
primary_emailstryesPrimary mailbox email address
quota{"allowed": int, "used": int}yesMailbox quota usage
statusstryesMailbox lifecycle status
updated_atstryesMailbox last update timestamp
aliases[{"alias": str, "is_catch_all"?: bool}]noAliases for the mailbox
workspace_idstr | nullnoWorkspace UUID for the mailbox
workspace_namestr | nullnoWorkspace display name
Request:
{
  "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>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.add",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "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>\")"
    }
  }
}
Response:
{
  "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
Create mailbox aliases.
PropertyValuePropertyValue
Requires permissionmailbox.alias.manageAuth requiredyes
Execution modesyncCapabilitymailbox.alias.manage
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
mailboxstryesMailbox UUID or email address from the route path
aliasstryes
is_catch_allboolno
FieldTypeRequiredDescription
aliasstryesMailbox alias email address
is_catch_allboolnoWhether this alias catches all unmatched local parts
Request:
{
  "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)"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.aliases.create",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Request:
{
  "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)"
    }
  }
}
Response:
{
  "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) -> {}
Delete mailbox aliases.
PropertyValuePropertyValue
Requires permissionmailbox.alias.manageAuth requiredyes
Execution modesyncCapabilitymailbox.alias.manage
Resource typeaccountResource ID fieldaccount_id
Public API routeDELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases/{alias}
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
aliasstryesMailbox alias address from the route path
mailboxstryesMailbox UUID or email address from the route path
FieldTypeRequiredDescription
result{}yes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.aliases.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", alias=\"<string>\", mailbox=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.aliases.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Request:
{
  "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>\")"
    }
  }
}
Response:
{
  "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
Bulk create mailboxes.
PropertyValuePropertyValue
Requires permissionmailbox.createAuth requiredyes
Execution modesyncCapabilitymailbox.create
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/mailboxes/bulk
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
domainstryesDomain UUID or domain name for the mailboxes
items[{"first_name": str, "last_name": str, "local_part": str}]yes
FieldTypeRequiredDescription
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}}]yes
failed[{"code": str, "index": int, "message": str}]yes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.bulk_add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain=\"example.com\", items=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.bulk_add",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "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>\")"
    }
  }
}
Response:
{
  "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
Get mailboxes.
PropertyValuePropertyValue
Requires permissionmailbox.viewAuth requiredyes
Execution modesyncCapabilitymailbox.view
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/mailboxes/{mailbox}
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
mailboxstryesMailbox UUID or email address from the route path
FieldTypeRequiredDescription
created_atstryesMailbox creation timestamp
domain_idstryesDomain UUID for the mailbox
domain_namestryesDomain name for the mailbox
first_namestryesMailbox user first name
idstryesMailbox UUID
last_namestryesMailbox user last name
local_partstryesMailbox local part before the at sign
primary_emailstryesPrimary mailbox email address
quota{"allowed": int, "used": int}yesMailbox quota usage
statusstryesMailbox lifecycle status
updated_atstryesMailbox last update timestamp
aliases[{"alias": str, "is_catch_all"?: bool}]noAliases for the mailbox
workspace_idstr | nullnoWorkspace UUID for the mailbox
workspace_namestr | nullnoWorkspace display name
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.get",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "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>\")"
    }
  }
}
Response:
{
  "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]
List mailboxes.
PropertyValuePropertyValue
Requires permissionmailbox.viewAuth requiredyes
Execution modesyncCapabilitymailbox.view
Resource typeaccountResource ID fieldaccount_id
Public API routeGET /v1/public/accounts/{account_id}/mailboxes
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
domainstr | nullnoFilter mailboxes by domain UUID or domain name
pageintnoOne-based mailbox page number
page_sizeintnoMaximum mailboxes per page
searchstr | nullnoSearch by mailbox address or display name
workspace_idstr | nullnoFilter mailboxes by workspace UUID
FieldTypeRequiredDescription
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}]yesMailboxes on this page
pageintyesCurrent one-based page number
page_sizeintyesMaximum items per page
totalintyesTotal matching mailboxes
Request:
{
  "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\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.list",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "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\")"
    }
  }
}
Response:
{
  "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
Reveal mailbox credentials.
PropertyValuePropertyValue
Requires permissionmailbox.credential.revealAuth requiredyes
Execution modesyncCapabilitymailbox.credential.reveal
Resource typeaccountResource ID fieldaccount_id
Public API routePOST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/reveal-credentials
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
mailboxstryesMailbox UUID or email address from the route path
FieldTypeRequiredDescription
passwordstryes
usernamestryes
Request:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.reveal_credentials(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\")"
}
Response:
{
  "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
}
Request:
{
  "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>\")"
    }
  }
}
Response:
{
  "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
Update mailboxes.
PropertyValuePropertyValue
Requires permissionmailbox.updateAuth requiredyes
Execution modesyncCapabilitymailbox.update
Resource typeaccountResource ID fieldaccount_id
Public API routePATCH /v1/public/accounts/{account_id}/mailboxes/{mailbox}
NameTypeRequiredDescription
account_idstryesAccount UUID from the route path
mailboxstryesMailbox UUID or email address from the route path
first_namestr | nullno
last_namestr | nullno
FieldTypeRequiredDescription
created_atstryesMailbox creation timestamp
domain_idstryesDomain UUID for the mailbox
domain_namestryesDomain name for the mailbox
first_namestryesMailbox user first name
idstryesMailbox UUID
last_namestryesMailbox user last name
local_partstryesMailbox local part before the at sign
primary_emailstryesPrimary mailbox email address
quota{"allowed": int, "used": int}yesMailbox quota usage
statusstryesMailbox lifecycle status
updated_atstryesMailbox last update timestamp
aliases[{"alias": str, "is_catch_all"?: bool}]noAliases for the mailbox
workspace_idstr | nullnoWorkspace UUID for the mailbox
workspace_namestr | nullnoWorkspace display name
Request:
{
  "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>\")"
}
Response:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.update",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Request:
{
  "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>\")"
    }
  }
}
Response:
{
  "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
  }
}