Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.
/ mail2beyond Public archive

A Python based SMTP server package and CLI that redirects incoming SMTP messages to upstream APIs like Google Chat, Slack and more!

License

Notifications You must be signed in to change notification settings

soluna-studios/mail2beyond

Repository files navigation

Mail2Beyond

Warning

This project is no longer maintained. Feel free to reach out if you would like to take ownership of the project going forward.

PyPI Documentation Build Unit Tests PyLint CodeQL

Mail2Beyond is a Python-based SMTP server designed to redirect incoming SMTP messages to upstream APIs such as Google Chat, Slack, or even your own API! This includes a command line interface (CLI) that can be used to run Mail2Beyond as a standalone server, as well as a Python package that you can use to extend or integrate into your own applications.

Installation

To install Mail2Beyond, simply run the following command:

pip install mail2beyond

Usage

Before starting the Mail2Beyond server, you must create your configuration file. Once you have your configuration file ready, you can start the server by running:

mail2beyond --config /path/to/your/config.yml

Developer Documentation

How is This Useful?

Emails are often ignored due to the amount of spam we receive on a daily basis. Many systems and applications use SMTP to send mail alerts, notices and other information that may be important. This commonly causes important information to be overlooked or outright ignored. At the same time, many organizations are using real-time messaging services like Google Chat and Slack on a daily basis. Mail2Beyond allows you to redirect these important messages to these services to help keep your teams informed!

Beyond messaging services, Mail2Beyond can also be extended to include connectors to your own APIs to build out complex automation flows based on incoming SMTP messages.

How Does Mail2Beyond Work?

Mail2Beyond continually listens for incoming SMTP messages. When a message is received, the message is parsed and checked against a set of admin configured mappings that dictate which API connector is to be used. Mappings define which SMTP headers should be checked for a specific regular expression match. When a match is found, the email contents are parsed and sent to the upstream API using the connector specified in the mapping.

About

A Python based SMTP server package and CLI that redirects incoming SMTP messages to upstream APIs like Google Chat, Slack and more!

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Languages