email-autoconf: Simple mail client configuration
email-autoconf is a Python package to provide a simple but feature-rich way to automatically configure your customers email client. It unites methods for automated mailbox configuration from Apple's Mobileconfig, Microsoft's Autodiscover and Mozilla's Autoconfig in one tool.
email-autoconf supports two work modes. One is with a database in which it can lookup usernames and display names and the other is without a database.
See Documentation for more information!
- Clone the repository
git clone https://gitlab.com/onlime/email-autoconf.git
- Create the venv with
python3 -m venv venv
- Activate the venv with
- Install required Python modules:
pip install -r requirements.txt
- Copy the example config from
instance/settings.pyand edit it to match your needs:
- Enter DB settings if needed otherwise comment it out.
- Adjust the SQL query or comment it out if one or both aren't needed.
- Change the server names to reflect your mail system
- Change the provider setting to whatever you need.
- Run the instance with
uwsgi --yaml uwsgi-http.yml --yaml uwsgi-http-instance.yml
- Try it with
We recommend to use an Apache or Nginx in front of this uWSGI server for example to provide HTTPS support.
Detailed documentation is available here: docs/documentation.md
Automx2 vs. email-autoconf
email-autoconf is meant to be a simpler and more flexible alternative to automx2 (GitHub: rseichter/automx2). Back in Feb 2020, when we started with this project, automx2 was still in its early stages and did not allow us to easily set up a database backend for mailaccount username lookups.
But in the meantime, automx2 has greatly evolved and might be the better option for you. It's your choice.