Sendria (formerly MailTrap) is a SMTP server designed to run in your dev/test environment, 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 prevent sending any dev/test emails to real people, no matter what address you provide.
Just point your app/email client tosmtp://127.0.0.1:1025and look at your emails onhttp://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, justsay thanks.
Icon made byFreepikfromflaticon.
2.2.2
- 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 supportsWebSockets.
- 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!
Sendriashould work on any POSIX platform wherePython
is available, it means Linux, MacOS/OSX etc.
Simplest way is to use Python's built-in package system:
Python 3 -m pip install sendria
You can also usepipxif you don't want to
mess with system packages and installSendriain virtual environment:
pipx install sendria
Voila!
Sendriais 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 useMailDump.
After installingSendriajust run command:
sendria --db mails.sqlite
Now send emails throughsmtp://127.0.0.1:1025,i.e.:
echo'From: Sendria <sendria@example >\n'\
'To: You <you@example >\n'\
'Subject: Welcome!\n\n'\
'Welcome to Sendria!'|\
curl smtp://localhost:1025 --mail-from sendria@example \
--mail-rcpt you@example --upload-file -or simpler withSMTPc:
smtpc send --host localhost:1025 --from sendria@example --to you@example \
--subject'Welcome!'--body'Welcome to Sendria!'Finally, look atSendriaGUI on127.0.0.1:1080.
If you want more details, run:
sendria --help
for more info, ie. how to protect access to gui.
Sendriaoffers RESTful API you can use to fetch list of messages or particular message, ie. for testing purposes.
You can use excellenthttpietool:
% 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/2.2.2 (https://sendria.net)
{
"code":"OK",
"data":[
{
"created_at":"2020-07-22T20:04:41",
"id":1,
"peer":"127.0.0.1:59872",
"recipients_envelope":[
"you@example"
],
"recipients_message_bcc":[],
"recipients_message_cc":[],
"recipients_message_to":[
"You <you@exampl >"
],
"sender_envelope":"sendria@example",
"sender_message":"Sendria <sendria@example >",
"size":191,
"source":"From: Sendria <sendria@example >\nTo: You <you@exampl >\nSubject: Welcome!\nX-Peer: ('127.0.0.1', 59872)\nX-MailFrom: sendria@example \nX-RcptTo: you@example \n\nWelcome to Sendria!\n",
"subject":"Welcome!",
"type":"text/plain"
}
],
"meta":{
"pages_total":3
}
}There are available endpoints:
GET /api/messages/- fetch list of emails. There is one query string param:pagefor pagination.DELETE /api/messages/- delete all emailsGET /api/messages/{message_id}.json- fetch email metadataGET /api/messages/{message_id}.plain- fetch plain part of emailGET /api/messages/{message_id}.html- fetch HTML part of emailGET /api/messages/{message_id}.source- fetch source of emailGET /api/messages/{message_id}.eml- download whole email as an EML fileGET /api/messages/{message_id}/parts/{cid}- download particular attachmentDELETE /api/messages/{message_id}- delete single email
There is also availableDocker image of Sendria. If you want to try, just run:
docker run -p 1025:1025 -p 1080:1080 msztolcman/sendriaI'm backend developer, not a frontend guy nor designer... If you are, and want to help, justmail 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 tomail meif you want and can help:)
Also, if you have an idea how to enhanceSendria,please fill the ticket.
Every idea, every feature request can help you, me and others!
For your rails application just set in yourenvironments/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
To configure Django to work withSendria,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
To useSendriain a Laravel project, configure your.envfile as follow:
MAIL_DRIVER=smtp
MAIL_HOST=127.0.0.1
MAIL_PORT=1025
MAIL_USERNAME=
MAIL_PASSWORD=
MAIL_ENCRYPTION=tcp
MAIL_FROM_ADDRESS=your@domain
As Sendria does not support TLS or SSL, it's very important to specifyMAIL_ENCRYPTION=tcp(instead of the defaultMAIL_ENCRYPTION=null),
otherwise you will get aSwift_TransportException(with errorstream_socket_client(): unable to connect to null://127.0.0.1).
If you want to hideSendriabehind nginx (ie. to terminate ssl) then you canuse example
config (see in addons).
To startSendriaautomatically withSupervisorthere is in
addons example config file for this purpose.
- Marcin Sztolcman ([email protected])
- Adrian Mönnich (author ofMailDump,base of
Sendria)
If you like or dislike this software, please do not hesitate to tell me about this me via email ([email protected]).
If you find bug or have an idea to enhance this tool, please use GitHub's issues.
- added configuration description for Laravel (thanks tuxfamilyfor PR)
- more dependencies fixes for Python 3.7
- updated deps in setup.py
- added messages pagination. One page is 100 messages. Can be browsed using
buttons next to "Search" window or keyboard shortcuts:
Ctrl-Shift-[Cursor Left]orCtrl-Shift-[Cursor Right]. - changed keyboard shortcuts: instead of
Ctrl-[Cursor Up]andCtrl-[Cursor Down]there is nowCtrl-Shift-[Cursor Up]andCtrl-Shift-[Cursor Down]. - allow configuring default
Sendriainstance using config file (seesendria --help->--config-file). - some fixes after hints from linters
- minor changes and fixes
- auth mechanisms are now implemented inaiosmtpd (thanksArzarothfor PR)
- huge improvements to handling DB inserts. Now all messages are stored in an internal queue, then it's saved to the DB. It solves many problems with performance and single-threaded SQLite (thanksKathrynNfor reporting)
- fixed API response when there is no data to return (#3) ( thanksKathrynNfor reporting)
- improved logging system, now log messages has log levels, also many simplifications in logging system
- Sendria now introduce as itself when connect through SMTP (also
--smtp-identCLI param added) - minor fixes and performance issues solved, updated dependencies
- next step in cleanups and making code modern
- rename MailTrap -> Sendria
- complete rewrite of backend part. Sendria is usingasyncioand aio-libsnow:
- using asynchronous version of libraries drastically improved performance
Sendrianow 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 fornginx andsupervisor
- all api's requests are now prefixed with
/api(look atAPI section) --htpasswdcli param is renamed to--http-auth
- fixed issue with old call do
gevent.signal - minimum gevent version set to 1.5.0
- bumped dependencies - security issues (dependabot)
- fixed layout issues (thanksradoslawhryciow)
- fixed encoding issues
- 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 forPipenv
- 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 atpull request 28)
- copy fromMailDumpv0.5.6
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
