Skip to content

Simple tool to check the sending and receiving of e-mails

Notifications You must be signed in to change notification settings

eieste/MailRound

Repository files navigation

MailRound

Docker Cloud Build Status Build Status PyPI version GitHub release GitHub tag (latest SemVer)

Simple tool to check the sending and receiving of e-mails.

You can use this tool to Check functionality of Mailservers (in and outgoing) If an error occurs during a connection check, the tool will inform you with the help of a webhook.

You can define Multiple Connections and which server send or recive the E-Mail. You can excatly define which server Send the test email and which should be received

Its also possible to use this tool on production Mailboxes. (The test E-mails are Automaticly deleted)

Use the docker-compose file to test this Application fast.

version: "3.2"

services:
  mailround:
    image: eieste/mailround:develop
    environment:
      MAILROUND_IN_IMAP_vps1_HOST: "examplemailserver.com"
      MAILROUND_IN_IMAP_vps1_PORT: 143
      MAILROUND_IN_IMAP_vps1_USE_SSL: true
      MAILROUND_IN_IMAP_vps1_USERNAME: "accuontusername"
      MAILROUND_IN_IMAP_vps1_PASSWORD: "randompassword"
      MAILROUND_IN_IMAP_vps1_EMAIL: "[email protected]"

      MAILROUND_OUT_SMTP_vps2_HOST: "examplemailserver.com"
      MAILROUND_OUT_SMTP_vps2_PORT: 143
      MAILROUND_OUT_SMTP_vps2_USE_SSL: true
      MAILROUND_OUT_SMTP_vps2_USERNAME: "accuontusername"
      MAILROUND_OUT_SMTP_vps2_PASSWORD: "randompassword"
      MAILROUND_OUT_SMTP_vps2_EMAIL: "[email protected]"

      MAILROUND_MAX_MAIL_RECEIVE_TIME: 60
      MAILROUND_ROUND: vps2:vps1
      MAILROUND_WEBHOOK_URL: "<FAAS>or<ROCKETCHAT> URL"

Getting Started Locally

To get started in your local environment

git clone [email protected]:eieste/MailRound.git

Setup the environment

cd mailround
python3 -m venv env
source env/bin.activate
python -m pip install -r requirements.txt

Update config

vi config/config.py

Run the application

python app.py

For more Assistance use my Documentation