Skip to content
This repository has been archived by the owner on Nov 27, 2020. It is now read-only.

Latest commit

 

History

History
271 lines (199 loc) · 9.65 KB

README.md

File metadata and controls

271 lines (199 loc) · 9.65 KB
Raw

MailTrap has been renamed to Sendria.

Please use Sendria now, MailTrap is abandoned.

Sendria

sendria version sendria license sendria python compatibility say thanks!

Sendria (formerly MailTrap) is a SMTP server designed to run in your dev/test environment, that is designed to catch any email you or your application is sending, and display it in a web interface instead of sending to real world. It help you prevents sending any dev/test emails to real people, no matter what address you provide. Just point your app/email client to smtp://127.0.0.1:1025 and look at your emails on http://127.0.0.1:1080.

Sendria is built on shoulders of:

  • MailCatcher - original idea comes of this tool by Samuel Cochran.
  • MailDump - base source code of Sendria (version pre 1.0.0), by Adrian Mönnich.

If you like this tool, just say thanks.

Current stable version

1.0.0

Features

  • Catch all emails and store it for display.
  • Full support for multipart messages.
  • View HTML and plain text parts of messages (if given part exists).
  • View source of email.
  • Lists attachments and allows separate downloading of parts.
  • Download original email to view in your native mail client(s).
  • Mail appears instantly if your browser supports WebSockets.
  • Optionally, send webhook on every received message.
  • Runs as a daemon in the background, optionally in foreground.
  • Keyboard navigation between messages.
  • Optionally password protected access to web interface.
  • Optionally password protected access to SMTP (SMTP AUTH).
  • It's all Python!

Installation

Sendria should work on any POSIX platform where Python is available, it means Linux, MacOS/OSX etc.

Simplest way is to use Python's built-in package system:

python3 -m pip install sendria

You can also use pipx if you don't want to mess with system packages and install Sendria in virtual environment:

pipx install sendria

Voila!

Python version

Sendria is tested against Python 3.7+. Older Python versions may work, or may not.

If you want to run this software on Python 2.6+, just use MailDump.

How to use

After installing Sendria, just run command:

sendria --db mails.sqlite

Now send emails through smtp://127.0.0.1:1025, ie.:

echo 'From: Sendria <sendria@example.com>\n'\
'To: You <you@exampl.com>\n'\
'Subject: Welcome!\n\n'\
'Welcome to Sendria!' | \
  curl smtp://localhost:1025 --mail-from sendria@example.com \
    --mail-rcpt you@example.com --upload-file -

And finally look at Sendria GUI on 127.0.0.1:1080.

If you want more details, run:

sendria --help

for more info, ie. how to protect access to gui.

API

Sendria offers RESTful API you can use to fetch list of messages or particular message, ie. for testing purposes.

You can use excellent httpie tool:

% http localhost:1080/api/messages/
HTTP/1.1 200 OK
Content-Length: 620
Content-Type: application/json; charset=utf-8
Date: Wed, 22 Jul 2020 20:04:46 GMT
Server: Sendria/1.0.0 (https://github.com/msztolcman/sendria)

{
    "code": "OK",
    "data": [
        {
            "created_at": "2020-07-22T20:04:41",
            "id": 1,
            "peer": "127.0.0.1:59872",
            "recipients_envelope": [
                "you@example.com"
            ],
            "recipients_message_bcc": [],
            "recipients_message_cc": [],
            "recipients_message_to": [
                "You <you@exampl.com>"
            ],
            "sender_envelope": "sendria@example.com",
            "sender_message": "Sendria <sendria@example.com>",
            "size": 191,
            "source": "From: Sendria <sendria@example.com>\nTo: You <you@exampl.com>\nSubject: Welcome!\nX-Peer: ('127.0.0.1', 59872)\nX-MailFrom: sendria@example.com\nX-RcptTo: you@example.com\n\nWelcome to Sendria!\n",
            "subject": "Welcome!",
            "type": "text/plain"
        }
    ]
}

There are available endpoints:

  • GET /api/messages/ - fetch list of all emails
  • DELETE /api/messages/ - delete all emails
  • GET /api/messages/{message_id}.json - fetch email metadata
  • GET /api/messages/{message_id}.plain - fetch plain part of email
  • GET /api/messages/{message_id}.html - fetch HTML part of email
  • GET /api/messages/{message_id}.source - fetch source of email
  • GET /api/messages/{message_id}.eml - download whole email as an EML file
  • GET /api/messages/{message_id}/parts/{cid} - download particular attachment
  • DELETE /api/messages/{message_id} - delete single email

Docker

There is also available Docker image of Sendria. If you want to try, just run:

docker run -p 1025:1025 -p 1080:1080 msztolcman/sendria

Help!

I'm backend developer, not a frontend guy nor designer... If you are, and want to help, just mail me!. I think GUI should be redesigned, or at least few minor issues could be solved. Also, project requires some logo and/or icon. Again, do not hesitate to mail me if you want and can help :)

Configure Rails

For your rails application just set in your environments/development.rb:

config.action_mailer.delivery_method = :smtp
config.action_mailer.smtp_settings = { :address => '127.0.0.1', :port => 1025 }
config.action_mailer.raise_delivery_errors = false

Configure Django

To configure Django to work with Sendria, add the following to your projects' settings.py:

if DEBUG:
    EMAIL_HOST = '127.0.0.1'
    EMAIL_HOST_USER = ''
    EMAIL_HOST_PASSWORD = ''
    EMAIL_PORT = 1025
    EMAIL_USE_TLS = False

Behind nginx

If you want to hide Sendria behind nginx (ie. to terminate ssl) then you can use example config (see in addons).

Supervisord

To start Sendria automatically with Supervisor there is in addons example config file for this purpose.

Authors

Contact

If you like or dislike this software, please do not hesitate to tell me about this me via email (marcin@urzenia.net).

If you find bug or have an idea to enhance this tool, please use GitHub's issues.

ChangeLog

v1.0.0

  • complete rewrite of backend part. Sendria is using asyncio and aio-libs now:
  • using asynchronous version of libraries drastically improved performance
  • Sendria now can send a webhook about every received message
  • show in GUI information about envelope sender and recipients
  • all API requests has their own namespace now: /api
  • allow to replace name of application or url in template
  • block truncating all messages from GUI (on demand)
  • fixed issues with WebSockets, should refresh mails list and reconnect if disconnected
  • fixed issues with autobuilding assets
  • many cleanups and reformatting code
  • addons for nginx and supervisor

Backward incompatible changes:

  • all api's requests are now prefixed with /api (look at API section)
  • --htpasswd cli param is renamed to --http-auth

v0.1.6

  • fixed issue with old call do gevent.signal
  • minimum gevent version set to 1.5.0

v0.1.4

  • bumped dependencies - security issues (dependabot)

v0.1.3

v0.1.2

  • fixed encoding issues

v0.1.0

  • better support for macOS/OSX
  • links now opens in new tab/window (added 'target="blank"')
  • show message if there is no assets generated and info how to to generate them
  • added debugs for SMTP when in debug mode
  • added support for Pipenv
  • HTML tab is default now when looking at particular message
  • converted to support Python 3.6+, drop support for lower Python versions
  • added SMTP auth support (look at pull request 28 )
  • copy from MailDump v0.5.6