Mailboxes

Manage SMTP mailboxes, credentials, and mailbox domains.

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.

Property	Value	Property	Value
Requires permission	mailbox.create	Auth required	yes
Execution mode	sync	Capability	mailbox.create
Resource type	account	Resource ID field	account_id
Public API route	POST /v1/public/accounts/{account_id}/mailboxes

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
domain	str	yes	Domain UUID or domain name for the mailbox
first_name	str	yes
last_name	str	yes
local_part	str	yes

Returns

Field	Type	Required	Description
created_at	str	yes	Mailbox creation timestamp
domain_id	str	yes	Domain UUID for the mailbox
domain_name	str	yes	Domain name for the mailbox
first_name	str	yes	Mailbox user first name
id	str	yes	Mailbox UUID
last_name	str	yes	Mailbox user last name
local_part	str	yes	Mailbox local part before the at sign
primary_email	str	yes	Primary mailbox email address
quota	{"allowed": int, "used": int}	yes	Mailbox quota usage
status	str	yes	Mailbox lifecycle status
updated_at	str	yes	Mailbox last update timestamp
aliases	[{"alias": str, "is_catch_all"?: bool}]	no	Aliases for the mailbox
workspace_id	str | null	no	Workspace UUID for the mailbox
workspace_name	str | null	no	Workspace display name

A2A example

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
}

MCP example

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.

Property	Value	Property	Value
Requires permission	mailbox.alias.manage	Auth required	yes
Execution mode	sync	Capability	mailbox.alias.manage
Resource type	account	Resource ID field	account_id
Public API route	POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
mailbox	str	yes	Mailbox UUID or email address from the route path
alias	str	yes
is_catch_all	bool	no

Returns

Field	Type	Required	Description
alias	str	yes	Mailbox alias email address
is_catch_all	bool	no	Whether this alias catches all unmatched local parts

A2A example

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
}

MCP example

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.

Property	Value	Property	Value
Requires permission	mailbox.alias.manage	Auth required	yes
Execution mode	sync	Capability	mailbox.alias.manage
Resource type	account	Resource ID field	account_id
Public API route	DELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases/{alias}

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
alias	str	yes	Mailbox alias address from the route path
mailbox	str	yes	Mailbox UUID or email address from the route path

Returns

Field	Type	Required	Description
result	{}	yes

A2A example

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
}

MCP example

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.

Property	Value	Property	Value
Requires permission	mailbox.create	Auth required	yes
Execution mode	sync	Capability	mailbox.create
Resource type	account	Resource ID field	account_id
Public API route	POST /v1/public/accounts/{account_id}/mailboxes/bulk

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
domain	str	yes	Domain UUID or domain name for the mailboxes
items	[{"first_name": str, "last_name": str, "local_part": str}]	yes

Returns

Field	Type	Required	Description
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

A2A example

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
}

MCP example

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.

Property	Value	Property	Value
Requires permission	mailbox.view	Auth required	yes
Execution mode	sync	Capability	mailbox.view
Resource type	account	Resource ID field	account_id
Public API route	GET /v1/public/accounts/{account_id}/mailboxes/{mailbox}

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
mailbox	str	yes	Mailbox UUID or email address from the route path

Returns

Field	Type	Required	Description
created_at	str	yes	Mailbox creation timestamp
domain_id	str	yes	Domain UUID for the mailbox
domain_name	str	yes	Domain name for the mailbox
first_name	str	yes	Mailbox user first name
id	str	yes	Mailbox UUID
last_name	str	yes	Mailbox user last name
local_part	str	yes	Mailbox local part before the at sign
primary_email	str	yes	Primary mailbox email address
quota	{"allowed": int, "used": int}	yes	Mailbox quota usage
status	str	yes	Mailbox lifecycle status
updated_at	str	yes	Mailbox last update timestamp
aliases	[{"alias": str, "is_catch_all"?: bool}]	no	Aliases for the mailbox
workspace_id	str | null	no	Workspace UUID for the mailbox
workspace_name	str | null	no	Workspace display name

A2A example

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
}

MCP example

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.

Property	Value	Property	Value
Requires permission	mailbox.view	Auth required	yes
Execution mode	sync	Capability	mailbox.view
Resource type	account	Resource ID field	account_id
Public API route	GET /v1/public/accounts/{account_id}/mailboxes

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
domain	str | null	no	Filter mailboxes by domain UUID or domain name
page	int	no	One-based mailbox page number
page_size	int	no	Maximum mailboxes per page
search	str | null	no	Search by mailbox address or display name
workspace_id	str | null	no	Filter mailboxes by workspace UUID

Returns

Field	Type	Required	Description
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}]	yes	Mailboxes on this page
page	int	yes	Current one-based page number
page_size	int	yes	Maximum items per page
total	int	yes	Total matching mailboxes

A2A example

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
}

MCP example

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.

Property	Value	Property	Value
Requires permission	mailbox.credential.reveal	Auth required	yes
Execution mode	sync	Capability	mailbox.credential.reveal
Resource type	account	Resource ID field	account_id
Public API route	POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/reveal-credentials

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
mailbox	str	yes	Mailbox UUID or email address from the route path

Returns

Field	Type	Required	Description
password	str	yes
username	str	yes

A2A example

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
}

MCP example

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.

Property	Value	Property	Value
Requires permission	mailbox.update	Auth required	yes
Execution mode	sync	Capability	mailbox.update
Resource type	account	Resource ID field	account_id
Public API route	PATCH /v1/public/accounts/{account_id}/mailboxes/{mailbox}

Arguments

Name	Type	Required	Description
account_id	str	yes	Account UUID from the route path
mailbox	str	yes	Mailbox UUID or email address from the route path
first_name	str | null	no
last_name	str | null	no

Returns

Field	Type	Required	Description
created_at	str	yes	Mailbox creation timestamp
domain_id	str	yes	Domain UUID for the mailbox
domain_name	str	yes	Domain name for the mailbox
first_name	str	yes	Mailbox user first name
id	str	yes	Mailbox UUID
last_name	str	yes	Mailbox user last name
local_part	str	yes	Mailbox local part before the at sign
primary_email	str	yes	Primary mailbox email address
quota	{"allowed": int, "used": int}	yes	Mailbox quota usage
status	str	yes	Mailbox lifecycle status
updated_at	str	yes	Mailbox last update timestamp
aliases	[{"alias": str, "is_catch_all"?: bool}]	no	Aliases for the mailbox
workspace_id	str | null	no	Workspace UUID for the mailbox
workspace_name	str | null	no	Workspace display name

A2A example

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
}

MCP example

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
  }
}