# Mail-in-a-Box Mail API

**Canonical:** https://apis.io/apis/mail-in-a-box/mail-in-a-box-mail-api/  
**Provider:** Mail-in-a-Box — https://apis.io/providers/mail-in-a-box/  
**Base URL:** https://mailinabox.email/admin  
**Documentation:** https://mailinabox.email/api-docs.html

Mail-in-a-Box Mail API is one of 7 APIs that [Mail-in-a-Box](https://apis.io/providers/mail-in-a-box/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Mail. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Mail operations, which include getting all users, getting all aliases, adding/updating/removing users and aliases and getting all mail domains.

## Operations (11)

| Method | Path | Summary |
|---|---|---|
| GET | `/mail/users` | Get mail users |
| POST | `/mail/users/add` | Add mail user |
| POST | `/mail/users/remove` | Remove mail user |
| POST | `/mail/users/privileges/add` | Add mail user privilege |
| POST | `/mail/users/privileges/remove` | Remove mail user privilege |
| POST | `/mail/users/password` | Set mail user password |
| GET | `/mail/users/privileges` | Get mail user privileges |
| GET | `/mail/domains` | Get mail domains |
| GET | `/mail/aliases` | Get mail aliases |
| POST | `/mail/aliases/add` | Upsert mail alias |
| POST | `/mail/aliases/remove` | Remove mail alias |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/mail-in-a-box/openapi/mail-in-a-box-mail-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/mail-in-a-box/json-schema/mail-in-a-box-sslcertificate-install-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/mail-in-a-box/json-schema/mail-in-a-box-mail-alias-upsert-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/mail-in-a-box/json-schema/mail-in-a-box-sslcsrgenerate-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/mail-in-a-box/json-schema/mail-in-a-box-system-update-packages-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/mail-in-a-box/json-schema/mail-in-a-box-system-backup-config-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/mail-in-a-box/json-schema/mail-in-a-box-web-domain-schema.json

## Other Mail-in-a-Box APIs (6)

- [Mail-in-a-Box DNS API](https://apis.io/apis/mail-in-a-box/mail-in-a-box-dns-api/)
- [Mail-in-a-Box MFA API](https://apis.io/apis/mail-in-a-box/mail-in-a-box-mfa-api/)
- [Mail-in-a-Box SSL API](https://apis.io/apis/mail-in-a-box/mail-in-a-box-ssl-api/)
- [Mail-in-a-Box System API](https://apis.io/apis/mail-in-a-box/mail-in-a-box-system-api/)
- [Mail-in-a-Box User API](https://apis.io/apis/mail-in-a-box/mail-in-a-box-user-api/)
- [Mail-in-a-Box Web API](https://apis.io/apis/mail-in-a-box/mail-in-a-box-web-api/)

## Tags

Mail

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/mail-in-a-box/mail-in-a-box-mail-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/mail-in-a-box/.