Mailgoose is a web application that allows the users to check whether their SPF, DMARC and DKIM configuration is set up correctly. CERT PL uses it to run bezpiecznapoczta.cert.pl, an online service that helps Polish institutions to configure their domains to decrease the probability of successful e-mail spoofing.

Under the hood, Mailgoose uses checkdmarc and dkimpy, among others.

Quick Start 🔨 | Docs 📚

Features

For an up-to-date list of features, please refer to the documentation.

Screenshots

Development

Tests

To run the tests, use:

./scripts/test

Code formatting

Mailgoose uses pre-commit to run linters and format the code. pre-commit is executed on CI to verify that the code is formatted properly.

To run it locally, use:

pre-commit run --all-files

To setup pre-commit so that it runs before each commit, use:

pre-commit install

Building the docs

To build the documentation, use:

cd docs
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt
make html

Releasing

Before creating new release for mailgoose, you should update files with new version number:

• scan/setup.py#L12 - version=""
• docs/conf.py#L36 - release = ""

Then create new release with given version.

Contributing

Contributions are welcome! We will appreciate both ideas for improvements (added as GitHub issues) as well as pull requests with new features or code improvements.

However obvious it may seem we kindly remind you that by contributing to mailgoose you agree that the BSD 3-Clause License shall apply to your input automatically, without the need for any additional declarations to be made.