https://github.com/eieste/mailround

Simple tool to check the sending and receiving of e-mails
https://github.com/eieste/mailround

chat check communication imap mail mailbox mailing mailserver monitoring server smtp webhook

Last synced: 5 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/eieste/mailround
• Owner: eieste
• Created: 2019-05-19T13:14:44.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2022-11-28T20:30:29.000Z (about 2 years ago)
• Last Synced: 2025-01-14T15:04:20.505Z (22 days ago)
• Topics: chat, check, communication, imap, mail, mailbox, mailing, mailserver, monitoring, server, smtp, webhook
• Language: Python
• Homepage:
• Size: 26.4 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# MailRound

![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/eieste/mailround.svg)

[![Build Status](https://travis-ci.com/eieste/MailRound.svg?branch=develop)](https://travis-ci.com/eieste/MailRound)

[![PyPI version](https://badge.fury.io/py/mailround.svg)](https://badge.fury.io/py/mailround)

![GitHub release](https://img.shields.io/github/release/eieste/mailround.svg)

![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/eieste/mailround.svg)

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.

```dockerfile

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: "or 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](https://github.com/eieste/MailRound/blob/develop/docs/overview.md)