bbf0ac5d47
2464: Introduce RESTful API r=mergify[bot] a=Diman0 ## What type of PR? Feature ## What does this PR do? Introduces a RESTful API for changing the complete Mailu config. Anything that can be configured in the web administration interface, can also be configured via the Mailu RESTful API. Via the swagger.json endpoint the complete OpenAPI specification can be retrieved. Via the endpoint swaggerui, a web client is available which shows all the endpoints, data models and allows you to submit requests. See docs/api.rst and docs/configuration.rst for details for enabling it. ### Related issue(s) - closes #445 ## Prerequisites Before we can consider review and merge, please make sure the following list is done and checked. If an entry in not applicable, you can check it or remove it from the list. - [x] In case of feature or enhancement: documentation updated accordingly - [x] Unless it's docs or a minor change: add [changelog](https://mailu.io/master/contributors/workflow.html#changelog) entry file. Co-authored-by: Alexander Graf <ghostwheel42@users.noreply.github.com> Co-authored-by: Dimitri Huisman <diman@huisman.xyz> |
2 years ago | |
|---|---|---|
| .github | 2 years ago | |
| core | 2 years ago | |
| design | 3 years ago | |
| docs | 2 years ago | |
| optional | 2 years ago | |
| setup | 2 years ago | |
| tests | 2 years ago | |
| towncrier | 2 years ago | |
| webmails | 2 years ago | |
| .gitignore | 2 years ago | |
| .mergify.yml | 3 years ago | |
| AUTHORS.md | 3 years ago | |
| CHANGELOG.md | 3 years ago | |
| CODE_OF_CONDUCT.md | 7 years ago | |
| CONTRIBUTING.md | 2 years ago | |
| ISSUE_TEMPLATE.md | 2 years ago | |
| LICENSE.md | 8 years ago | |
| PULL_REQUEST_TEMPLATE.md | 3 years ago | |
| README.md | 2 years ago | |
| RELEASE_TEMPLATE.md | 3 years ago | |
| SECURITY.md | 2 years ago | |
| bors.toml | 3 years ago | |
| pyproject.toml | 5 years ago | |
README.md
Mailu is a simple yet full-featured mail server as a set of Docker images. It is free software (both as in free beer and as in free speech), open to suggestions and external contributions. The project aims at providing people with an easily setup, easily maintained and full-featured mail server while not shipping proprietary software nor unrelated features often found in popular groupware.
Most of the documentation is available on our Website, you can also try our demo server before setting up your own, and come talk to us on Matrix.
Features
Main features include:
- Standard email server, IMAP and IMAP+, SMTP and Submission with autoconfiguration profiles for clients
- Advanced email features, aliases, domain aliases, custom routing
- Web access, multiple Webmails and administration interface
- User features, aliases, auto-reply, auto-forward, fetched accounts
- Admin features, global admins, announcements, per-domain delegation, quotas
- Security, enforced TLS, DANE, MTA-STS, Letsencrypt!, outgoing DKIM, anti-virus scanner, Snuffleupagus, block malicious attachments
- Antispam, auto-learn, greylisting, DMARC and SPF, anti-spoofing
- Freedom, all FOSS components, no tracker included
Contributing
Mailu is free software, open to suggestions and contributions. All components are free software and compatible with the MIT license. All specific configuration files, Dockerfiles and code are placed under the MIT license.