Naar hoofdinhoud gaan

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.

Mailboxen

SMTP-mailboxen, referenties en mailboxdomeinen beheren. De voorbeelden gebruiken de A2A-codemodus. MCP biedt dezelfde codemodus via het hulpmiddel execute.

Functies

mailboxes.add

mailboxes.add(account_id: str, domain: str, first_name: str, last_name: str, local_part: str) -> Mailbox
Mailboxen: mailboxes.add.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingmailbox.createAuthenticatie vereistja
UitvoermodussyncMogelijkheidmailbox.create
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routePOST /v1/public/accounts/{account_id}/mailboxes
NaamTypeVereist
account_idstrja
domainstrja
first_namestrja
last_namestrja
local_partstrja
VeldTypeVereist
created_atstrja
domain_idstrja
domain_namestrja
first_namestrja
idstrja
last_namestrja
local_partstrja
primary_emailstrja
quota{"allowed": int, "used": int}ja
statusstrja
updated_atstrja
aliases[{"alias": str, "is_catch_all"?: bool}]nee
workspace_idstr | nullnee
workspace_namestr | nullnee
Aanvraag:
{
  "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>\")"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.add",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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>\")"
    }
  }
}
Respons:
{
  "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
Mailboxen: mailboxes.aliases.create.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingmailbox.alias.manageAuthenticatie vereistja
UitvoermodussyncMogelijkheidmailbox.alias.manage
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routePOST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases
NaamTypeVereist
account_idstrja
mailboxstrja
aliasstrja
is_catch_allboolnee
VeldTypeVereist
aliasstrja
is_catch_allboolnee
Aanvraag:
{
  "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)"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.aliases.create",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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)"
    }
  }
}
Respons:
{
  "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) -> {}
Mailboxen: mailboxes.aliases.delete.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingmailbox.alias.manageAuthenticatie vereistja
UitvoermodussyncMogelijkheidmailbox.alias.manage
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routeDELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases/{alias}
NaamTypeVereist
account_idstrja
aliasstrja
mailboxstrja
VeldTypeVereist
result{}ja
Aanvraag:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.aliases.delete(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", alias=\"<string>\", mailbox=\"<string>\")"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {}
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.aliases.delete",
      "status": "completed",
      "result": {}
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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>\")"
    }
  }
}
Respons:
{
  "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
Mailboxen: mailboxes.bulk_add.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingmailbox.createAuthenticatie vereistja
UitvoermodussyncMogelijkheidmailbox.create
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routePOST /v1/public/accounts/{account_id}/mailboxes/bulk
NaamTypeVereist
account_idstrja
domainstrja
items[{"first_name": str, "last_name": str, "local_part": str}]ja
VeldTypeVereist
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}}]ja
failed[{"code": str, "index": int, "message": str}]ja
Aanvraag:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.bulk_add(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", domain=\"example.com\", items=\"<string>\")"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.bulk_add",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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>\")"
    }
  }
}
Respons:
{
  "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
Mailboxen: mailboxes.get.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingmailbox.viewAuthenticatie vereistja
UitvoermodussyncMogelijkheidmailbox.view
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routeGET /v1/public/accounts/{account_id}/mailboxes/{mailbox}
NaamTypeVereist
account_idstrja
mailboxstrja
VeldTypeVereist
created_atstrja
domain_idstrja
domain_namestrja
first_namestrja
idstrja
last_namestrja
local_partstrja
primary_emailstrja
quota{"allowed": int, "used": int}ja
statusstrja
updated_atstrja
aliases[{"alias": str, "is_catch_all"?: bool}]nee
workspace_idstr | nullnee
workspace_namestr | nullnee
Aanvraag:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\")"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.get",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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>\")"
    }
  }
}
Respons:
{
  "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]
Mailboxen: mailboxes.list.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingmailbox.viewAuthenticatie vereistja
UitvoermodussyncMogelijkheidmailbox.view
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routeGET /v1/public/accounts/{account_id}/mailboxes
NaamTypeVereist
account_idstrja
domainstr | nullnee
pageintnee
page_sizeintnee
searchstr | nullnee
workspace_idstr | nullnee
VeldTypeVereist
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}]ja
pageintja
page_sizeintja
totalintja
Aanvraag:
{
  "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\")"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.list",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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\")"
    }
  }
}
Respons:
{
  "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
Mailboxen: mailboxes.reveal_credentials.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingmailbox.credential.revealAuthenticatie vereistja
UitvoermodussyncMogelijkheidmailbox.credential.reveal
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routePOST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/reveal-credentials
NaamTypeVereist
account_idstrja
mailboxstrja
VeldTypeVereist
passwordstrja
usernamestrja
Aanvraag:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "mailboxes.reveal_credentials(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", mailbox=\"<string>\")"
}
Respons:
{
  "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
}
Aanvraag:
{
  "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>\")"
    }
  }
}
Respons:
{
  "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
Mailboxen: mailboxes.update.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingmailbox.updateAuthenticatie vereistja
UitvoermodussyncMogelijkheidmailbox.update
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routePATCH /v1/public/accounts/{account_id}/mailboxes/{mailbox}
NaamTypeVereist
account_idstrja
mailboxstrja
first_namestr | nullnee
last_namestr | nullnee
VeldTypeVereist
created_atstrja
domain_idstrja
domain_namestrja
first_namestrja
idstrja
last_namestrja
local_partstrja
primary_emailstrja
quota{"allowed": int, "used": int}ja
statusstrja
updated_atstrja
aliases[{"alias": str, "is_catch_all"?: bool}]nee
workspace_idstr | nullnee
workspace_namestr | nullnee
Aanvraag:
{
  "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>\")"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "mailboxes.update",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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>\")"
    }
  }
}
Respons:
{
  "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
  }
}