Mailboxen
SMTP-mailboxen, referenties en mailboxdomeinen beheren. De voorbeelden gebruiken de A2A-codemodus. MCP biedt dezelfde codemodus via het hulpmiddelexecute.
Functies
mailboxes.add
mailboxes.add.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | mailbox.create | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | mailbox.create |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | POST /v1/public/accounts/{account_id}/mailboxes |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
domain | str | ja |
first_name | str | ja |
last_name | str | ja |
local_part | str | ja |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
created_at | str | ja |
domain_id | str | ja |
domain_name | str | ja |
first_name | str | ja |
id | str | ja |
last_name | str | ja |
local_part | str | ja |
primary_email | str | ja |
quota | {"allowed": int, "used": int} | ja |
status | str | ja |
updated_at | str | ja |
aliases | [{"alias": str, "is_catch_all"?: bool}] | nee |
workspace_id | str | null | nee |
workspace_name | str | null | nee |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons:
mailboxes.aliases.create
mailboxes.aliases.create.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | mailbox.alias.manage | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | mailbox.alias.manage |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
mailbox | str | ja |
alias | str | ja |
is_catch_all | bool | nee |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
alias | str | ja |
is_catch_all | bool | nee |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons:
mailboxes.aliases.delete
mailboxes.aliases.delete.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | mailbox.alias.manage | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | mailbox.alias.manage |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | DELETE /v1/public/accounts/{account_id}/mailboxes/{mailbox}/aliases/{alias} |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
alias | str | ja |
mailbox | str | ja |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
result | {} | ja |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons:
mailboxes.bulk_add
mailboxes.bulk_add.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | mailbox.create | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | mailbox.create |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | POST /v1/public/accounts/{account_id}/mailboxes/bulk |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
domain | str | ja |
items | [{"first_name": str, "last_name": str, "local_part": str}] | ja |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
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 |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons:
mailboxes.get
mailboxes.get.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | mailbox.view | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | mailbox.view |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | GET /v1/public/accounts/{account_id}/mailboxes/{mailbox} |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
mailbox | str | ja |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
created_at | str | ja |
domain_id | str | ja |
domain_name | str | ja |
first_name | str | ja |
id | str | ja |
last_name | str | ja |
local_part | str | ja |
primary_email | str | ja |
quota | {"allowed": int, "used": int} | ja |
status | str | ja |
updated_at | str | ja |
aliases | [{"alias": str, "is_catch_all"?: bool}] | nee |
workspace_id | str | null | nee |
workspace_name | str | null | nee |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons:
mailboxes.list
mailboxes.list.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | mailbox.view | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | mailbox.view |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | GET /v1/public/accounts/{account_id}/mailboxes |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
domain | str | null | nee |
page | int | nee |
page_size | int | nee |
search | str | null | nee |
workspace_id | str | null | nee |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
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 |
page | int | ja |
page_size | int | ja |
total | int | ja |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons:
mailboxes.reveal_credentials
mailboxes.reveal_credentials.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | mailbox.credential.reveal | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | mailbox.credential.reveal |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | POST /v1/public/accounts/{account_id}/mailboxes/{mailbox}/reveal-credentials |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
mailbox | str | ja |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
password | str | ja |
username | str | ja |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons:
mailboxes.update
mailboxes.update.
| Eigenschap | Waarde | Eigenschap | Waarde |
|---|---|---|---|
| Vereiste machtiging | mailbox.update | Authenticatie vereist | ja |
| Uitvoermodus | sync | Mogelijkheid | mailbox.update |
| Resourcetype | account | Resource-ID-veld | account_id |
| Openbare API-route | PATCH /v1/public/accounts/{account_id}/mailboxes/{mailbox} |
Argumenten
Argumenten
| Naam | Type | Vereist |
|---|---|---|
account_id | str | ja |
mailbox | str | ja |
first_name | str | null | nee |
last_name | str | null | nee |
Retourneert
Retourneert
| Veld | Type | Vereist |
|---|---|---|
created_at | str | ja |
domain_id | str | ja |
domain_name | str | ja |
first_name | str | ja |
id | str | ja |
last_name | str | ja |
local_part | str | ja |
primary_email | str | ja |
quota | {"allowed": int, "used": int} | ja |
status | str | ja |
updated_at | str | ja |
aliases | [{"alias": str, "is_catch_all"?: bool}] | nee |
workspace_id | str | null | nee |
workspace_name | str | null | nee |
A2A-voorbeeld
A2A-voorbeeld
Aanvraag:Respons:
MCP-voorbeeld
MCP-voorbeeld
Aanvraag:Respons: