API Reference
The full interactive API reference is available directly from the live server:
Endpoint Summary
Auth (/api/v1/auth)
| Method | Path | Description |
POST | /auth/login | Login — returns admin or user token |
POST | /auth/logout | Invalidate current token |
POST | /auth/signup | Self-registration (when enabled) |
POST | /auth/refresh | Refresh token |
GET | /auth/me | Current token info |
Mail (/api/v1/mail)
| Method | Path | Description |
POST | /mail/send | Send an email |
GET | /mail/inbox | List inbox messages |
GET | /mail/sent | List sent messages |
GET | /mail/delivery-log | Delivery log (admin) |
GET | /mail/delivery-log/sync | Sync log from Postfix (admin) |
Mailbox (/api/v1/mailbox)
| Method | Path | Description |
GET | /mailbox/{email}/folders | List IMAP folders |
GET | /mailbox/{email}/folders/{folder}/messages | List messages in folder |
GET | /mailbox/{email}/folders/{folder}/messages/{uid} | Read a message |
GET | /mailbox/{email}/folders/{folder}/messages/{uid}/attachments | List attachments |
GET | /mailbox/{email}/folders/{folder}/messages/{uid}/attachments/{name} | Download attachment |
Users (/api/v1/users)
| Method | Path | Description |
GET | /users | List users (admin or scoped) |
POST | /users | Create a user |
GET | /users/me | Get current authenticated user info |
GET | /users/{email} | Get a user |
PUT | /users/{email} | Update a user |
DELETE | /users/{email} | Delete a user |
POST | /users/{email}/enable | Enable a user |
POST | /users/{email}/disable | Disable a user |
POST | /users/{email}/reset-password | Reset password |
DELETE | /users/{email}/purge | Permanently delete mailbox data |
Domains (/api/v1/domains)
| Method | Path | Description |
GET | /domains | List domains |
POST | /domains | Add a domain |
GET | /domains/pending | List domains pending approval |
GET | /domains/{domain} | Get domain details |
PUT | /domains/{domain} | Update domain |
DELETE | /domains/{domain} | Delete domain |
GET | /domains/{domain}/verify | Verify DNS records |
POST | /domains/{domain}/approve | Approve pending domain |
POST | /domains/{domain}/dkim | Generate new DKIM key |
GET | /domains/{domain}/dkim | Get DKIM public key |
Tokens (/api/v1/tokens)
| Method | Path | Description |
GET | /tokens | List API tokens |
POST | /tokens | Create a token |
GET | /tokens/{id} | Get a token |
PUT | /tokens/{id} | Update a token |
DELETE | /tokens/{id} | Revoke a token |
Stats (/api/v1/stats)
| Method | Path | Description |
GET | /stats/delivery | Delivery stats (success/failure/bounce) |
GET | /stats/domains | Per-domain delivery breakdown |
GET | /stats/users/{email} | Per-user stats |
Permissions (/api/v1/permissions)
| Method | Path | Description |
GET | /permissions | List all permissions (admin) |
POST | /permissions | Grant a permission (admin) |
POST | /permissions/bulk | Grant multiple permissions at once (admin) |
DELETE | /permissions/{id} | Revoke a permission (admin) |
GET | /permissions/mine | Get own permissions (user) |