vmario
/
email-autoconf
mirror of https://gitlab.com/onlime/email-autoconf.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Python application for email client auto-configuration
70 Commits
1 Branch
0 Tags
125 KiB
Python 67.8%
Jinja 11.6%
HTML 8.7%
Shell 5.5%
CSS 3.7%
Other 2.7%
 
 
 
 
 
 
Go to file
Philip Iezzi e64611202c updated all pip packags for Flask 2.2 
fixes #3
 		2022-11-12 11:43:36 +01:00
.vscode cleanup confusing use of ports 8443,8080 2020-04-13 15:34:51 +02:00
contrib cleanup confusing use of ports 8443,8080 2020-04-13 15:34:51 +02:00
docker cleanup confusing use of ports 8443,8080 2020-04-13 15:34:51 +02:00
docs updated documentation and added Testing section 2021-08-26 01:00:42 +02:00
email_autoconf Prepare release 2021.8 2021-08-25 18:35:03 +02:00
instance updated README and install documentation 2021-08-25 18:22:16 +02:00
scripts change to official sonarsource/sonar-scanner-cli image for SonarScanner 2022-10-25 16:30:55 +02:00
tests Migrate to mysql-connector-python 2021-07-18 22:43:54 +00:00
.dockerignore cleanup confusing use of ports 8443,8080 2020-04-13 15:34:51 +02:00
.gitignore cleanup confusing use of ports 8443,8080 2020-04-13 15:34:51 +02:00
.gitlab-ci.yml change to official sonarsource/sonar-scanner-cli image for SonarScanner 2022-10-25 16:30:55 +02:00
CHANGELOG.md Prepare release 2021.8 2021-08-25 18:35:03 +02:00
Dockerfile Migrate to mysql-connector-python 2021-07-18 22:43:54 +00:00
LICENSE cleanup confusing use of ports 8443,8080 2020-04-13 15:34:51 +02:00
README.md updated README and install documentation 2021-08-25 18:22:16 +02:00
docker-compose.yml Migrate to mysql-connector-python 2021-07-18 22:43:54 +00:00
requirements.txt updated all pip packags for Flask 2.2 2022-11-12 11:43:36 +01:00
setup.py introduce __version__ package variable 2021-08-20 15:54:38 +02:00
tests.py improved testing 2020-03-12 11:57:46 +01:00
uwsgi-http-instance.yml_example cleanup confusing use of ports 8443,8080 2020-04-13 15:34:51 +02:00
uwsgi-http.yml cleanup confusing use of ports 8443,8080 2020-04-13 15:34:51 +02:00
uwsgi-https-instance.yml_example cleanup confusing use of ports 8443,8080 2020-04-13 15:34:51 +02:00
uwsgi-socket-instance.yml_example cleanup confusing use of ports 8443,8080 2020-04-13 15:34:51 +02:00

README.md

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.

QUICKSTART

See Documentation for more information!

  1. Clone the repository git clone https://gitlab.com/onlime/email-autoconf.git
  2. Create the venv with python3 -m venv venv
  3. Activate the venv with . venv/bin/activate
  4. Install required Python modules: pip install -r requirements.txt
  5. Copy the example config from instance/settings.py_example to instance/settings.py and edit it to match your needs:
    1. Enter DB settings if needed otherwise comment it out.
    2. Adjust the SQL query or comment it out if one or both aren't needed.
    3. Change the server names to reflect your mail system
    4. Change the provider setting to whatever you need.
  6. Run the instance with uwsgi --yaml uwsgi-http.yml --yaml uwsgi-http-instance.yml
  7. Try it with curl localhost:8080/mail/config-v1.1.xml?emailaddress=testaddress@example.com

We recommend to use an Apache or Nginx in front of this uWSGI server for example to provide HTTPS support.

Documentation

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.

About email-autoconf

The project is hosted on GitLab. Please use the project's issue tracker if you find bugs.

email-autoconf was written by Philip Iezzi @piezzi and Martin Wittwer @wittwer-it for Onlime GmbH.