Email Account Management
Create and manage email mailboxes on your domain. Requires a domain linked to your project.
Endpoints (11)
Enable email for a domain linked to your project. The domain must already be linked via the dashboard Domains tab. DNS (MX, SPF, mail CNAME) is pre-configured for domains registered through WebsitePublisher.
| Field | Type | Required | Description |
|---|---|---|---|
domain |
string | ✓ Yes | Domain name to enable email for (e.g. "mycompany.nl"). Must be linked to this project. |
Disable email for a domain. Removes the domain from the mail system. Fails if active mailboxes still exist.
| Field | Type | Required | Description |
|---|---|---|---|
domain |
string | ✓ Yes | Domain name to disable email for. |
List all email-enabled domains for your project, with mailbox counts.
No input parameters required.
Create a mailbox on one of your email-enabled domains. Password is bcrypt-hashed for Dovecot. Pi nodes sync within ~1 minute.
| Field | Type | Required | Description |
|---|---|---|---|
email |
string | ✓ Yes | Full email address (e.g. "info@mycompany.nl"). Domain must be email-enabled on this project. |
password |
string | ✓ Yes | Plain text password — will be bcrypt-hashed before storage. |
quota_mb |
integer | No | Mailbox quota in MB (default: 1024). |
Remove a mailbox from your domain. Default is soft delete (active=0). Use hard_delete=true to remove entirely.
| Field | Type | Required | Description |
|---|---|---|---|
email |
string | ✓ Yes | Email address of the mailbox to remove. |
hard_delete |
boolean | No | If true, deletes the row entirely. If false (default), sets active=0. |
List all mailboxes on your project's email-enabled domains. Optionally filter by domain.
| Field | Type | Required | Description |
|---|---|---|---|
domain |
string | No | Filter users by domain (e.g. "mycompany.nl"). |
Change the password of an existing mailbox on your domain.
| Field | Type | Required | Description |
|---|---|---|---|
email |
string | ✓ Yes | Email address of the user. |
password |
string | ✓ Yes | New plain text password — will be bcrypt-hashed. |
[Admin] Register a mail domain without project scoping. For platform management only.
| Field | Type | Required | Description |
|---|---|---|---|
domain |
string | ✓ Yes | Domain name to register. |
project_id |
integer | No | Optional: assign domain to a specific project (WebSumo ID). |
[Admin] Remove a mail domain. Fails if active users still exist.
| Field | Type | Required | Description |
|---|---|---|---|
domain |
string | ✓ Yes | Domain name to remove. |
[Admin] List all registered Pi sync nodes with last sync timestamp.
No input parameters required.
[Admin] Register a new Pi sync node. Generates a unique sync key.
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | ✓ Yes | Node identifier (e.g. "mpi02"). |
ip_address |
string | No | Optional IP whitelist for extra security. |
MCP Tool Names
When using this integration through an AI assistant (Claude, ChatGPT, Cursor, etc.), the endpoints are available as MCP tools:
| Endpoint | MCP Tool Name |
|---|---|
| enable-email | email_account_enable_email |
| disable-email | email_account_disable_email |
| list-domains | email_account_list_domains |
| add-user | email_account_add_user |
| remove-user | email_account_remove_user |
| list-users | email_account_list_users |
| update-password | email_account_update_password |
| add-domain | email_account_add_domain |
| remove-domain | email_account_remove_domain |
| list-nodes | email_account_list_nodes |
| add-node | email_account_add_node |