opentrashmail/README.md
2019-08-16 15:06:42 +02:00

2.9 KiB

Open Trashmail

Open Trashmail

Apache License HitCount

Host your own trashmail solution to use with your own domains or subdomains

Screenshot of Open Trashmail

Roadmap

  • Mailserver
    • Storing received mails in JSON
    • Storing file attachments
  • Docker files and configs
  • Web interface
    • Choose email
    • Get random email address
    • Download attachments in a safe way
    • Display Text/HTML
    • API so all features from the site can also be automated and integrated
    • Automatically check for new emails while on site
    • Secure HTML so no malicious things can be loaded
    • Display embedded images inline using Content-ID
    • Admin overview for all available email addresses
    • Delete messages
    • Make better theme
  • Configurable settings
    • Choose domains for random generation
    • Choose if out-of-scope emails are discarded
    • Honeypot mode where all emails are also saved for a catchall account
    • Optionally secure whole site with a password
    • Optinally allow site to be seen only from specific IP Range

Features

  • Python powered mail server that works out of the box for any domain you throw at it
  • Web interface to manage emails
  • Generate random email adresses
  • 100% file based, no database needed

Quick start

docker run --it -p 25:25 -p 80:80 hascheksolutions/opentrashmail

How it works

The heart of Open Trashmail is a python powered SMTP server that listens on incoming emails and stores them as json objects. The server doesn't have to know the right Email domain, it will just catch everything it receives. You only have to expose port 25 to the web and set an MX record of your domain pointing to the IP adress of your machine.

The server then saves all received emails as JSON objects and the web interface can access it.