Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/msztolcman/sendria
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.
https://github.com/msztolcman/sendria
developer-tools email mail mailcatcher mailcatcher-alternative maildump maildump-alternative mailtrap mta-server smtp smtp-server
Last synced: 4 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/msztolcman/sendria
- Owner: msztolcman
- License: mit
- Created: 2020-10-03T08:43:01.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-18T12:32:20.000Z (about 2 years ago)
- Last Synced: 2024-08-20T01:58:54.027Z (4 months ago)
- Topics: developer-tools, email, mail, mailcatcher, mailcatcher-alternative, maildump, maildump-alternative, mailtrap, mta-server, smtp, smtp-server
- Language: JavaScript
- Homepage:
- Size: 1.68 MB
- Stars: 142
- Watchers: 6
- Forks: 14
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Sendria
==========
[](https://pypi.python.org/pypi/sendria)
[](https://pypi.python.org/pypi/sendria)
[](https://pypi.python.org/pypi/sendria)
[](https://pepy.tech/project/sendria)
[](https://saythanks.io/to/marcin%40urzenia.net)
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 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](https://mailcatcher.me/) - original idea comes of this tool by Samuel Cochran.
* [MailDump](https://github.com/ThiefMaster/maildump) - base source code of `Sendria` (version pre 1.0.0), by Adrian Mönnich.
If you like this tool, just [say thanks](https://saythanks.io/to/marcin%40urzenia.net).
Icon made by [Freepik](http://www.freepik.com/) from [www.flaticon.com](https://www.flaticon.com/).
Current stable version
----------------------
2.2.2
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](https://en.wikipedia.org/wiki/WebSocket).
* 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](http://python.org)
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](https://pipxproject.github.io/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](https://github.com/ThiefMaster/maildump).
How to use
----------
[After installing](#installation) `Sendria` just run command:
sendria --db mails.sqlite
Now send emails through `smtp://127.0.0.1:1025`, i.e.:
```shell
echo 'From: Sendria \n'\
'To: You \n'\
'Subject: Welcome!\n\n'\
'Welcome to Sendria!' | \
curl smtp://localhost:1025 --mail-from [email protected] \
--mail-rcpt [email protected] --upload-file -
```
or simpler with [SMTPc](https://github.com/msztolcman/smtpc/):
```shell
smtpc send --host localhost:1025 --from [email protected] --to [email protected] \
--subject 'Welcome!' --body 'Welcome to Sendria!'
```
Finally, look at `Sendria` GUI on [127.0.0.1:1080](http://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](https://httpie.org/) tool:
```shell
% 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": [
"[email protected]"
],
"recipients_message_bcc": [],
"recipients_message_cc": [],
"recipients_message_to": [
"You "
],
"sender_envelope": "[email protected]",
"sender_message": "Sendria ",
"size": 191,
"source": "From: Sendria \nTo: You \nSubject: Welcome!\nX-Peer: ('127.0.0.1', 59872)\nX-MailFrom: [email protected]\nX-RcptTo: [email protected]\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: `page` for pagination.
* `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](https://hub.docker.com/r/msztolcman/sendria).
If you want to try, just run:
```shell
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!](mailto:[email protected]).
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](mailto:[email protected]) if you want and can help :)
Also, if you have an idea how to enhance `Sendria`, [please fill the ticket](https://github.com/msztolcman/sendria/issues).
Every idea, every feature request can help you, me and others!
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
Configure Laravel
----------------
To use `Sendria` in a Laravel project, configure your `.env` file as follow:
MAIL_DRIVER=smtp
MAIL_HOST=127.0.0.1
MAIL_PORT=1025
MAIL_USERNAME=
MAIL_PASSWORD=
MAIL_ENCRYPTION=tcp
[email protected]
As Sendria does not support TLS or SSL, it's very important to specify `MAIL_ENCRYPTION=tcp` (instead of the default `MAIL_ENCRYPTION=null`),
otherwise you will get a `Swift_TransportException` (with error `stream_socket_client(): unable to connect to null://127.0.0.1`).
Behind nginx
------------
If you want to hide `Sendria` behind nginx (ie. to terminate ssl) then you can [use example
config (see in addons)](https://github.com/msztolcman/sendria/tree/master/addons/nginx.conf).
Supervisord
-----------
To start `Sendria` automatically with [Supervisor](https://supervisord.org/) there is in
[addons example config file for this purpose](https://github.com/msztolcman/sendria/tree/master/addons/supervisor.conf).
Authors
-------
* Marcin Sztolcman ([[email protected]](mailto:[email protected]))
* Adrian Mönnich (author of [MailDump](https://github.com/ThiefMaster/maildump), base of `Sendria`)
Contact
-------
If you like or dislike this software, please do not hesitate to tell me about
this me via email ([[email protected]](mailto:[email protected])).
If you find bug or have an idea to enhance this tool, please use GitHub's
[issues](https://github.com/msztolcman/sendria/issues).
ChangeLog
---------
### v2.3.0
* added configuration description for Laravel (thanks
[tuxfamily](https://github.com/tuxfamily) for PR)
### v2.2.2
* more dependencies fixes for Python 3.7
### v2.2.1
* updated deps in setup.py
### v.2.2.0
* added messages pagination. One page is 100 messages. Can be browsed using
buttons next to "Search" window or keyboard shortcuts: `Ctrl-Shift-[Cursor Left]`
or `Ctrl-Shift-[Cursor Right]`.
* changed keyboard shortcuts: instead of `Ctrl-[Cursor Up]` and `Ctrl-[Cursor Down]`
there is now `Ctrl-Shift-[Cursor Up]` and `Ctrl-Shift-[Cursor Down]`.
* allow configuring default `Sendria` instance using config file (see `sendria --help`
-> `--config-file`).
* some fixes after hints from linters
* minor changes and fixes
### v2.1.0
* auth mechanisms are now implemented in [aiosmtpd](https://aiosmtpd.readthedocs.io)
(thanks [Arzaroth](https://github.com/Arzaroth) for 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 (thanks [KathrynN](https://github.com/KathrynN) for reporting)
* fixed API response when there is no data to return (#3) (
thanks [KathrynN](https://github.com/KathrynN) for 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-ident` CLI param added)
* minor fixes and performance issues solved, updated dependencies
* next step in cleanups and making code modern
### v2.0.1
* new icon (by [Freepik](http://www.freepik.com/) from [www.flaticon.com](https://www.flaticon.com/))
### v2.0.0
* rename MailTrap -> Sendria
### v1.0.0
* complete rewrite of backend part. Sendria is using [asyncio](https://docs.python.org/3/library/asyncio.html) and
[aio-libs](https://github.com/aio-libs/) now:
* switch to [aiohttp](https://docs.aiohttp.org/) from Flask
* switch to [aiosmtpd](https://aiosmtpd.readthedocs.io) from [smtpd](https://docs.python.org/3/library/smtpd.html)
* switch to [aiosqlite](https://github.com/omnilib/aiosqlite) from [sqlite3](https://docs.python.org/3/library/sqlite3.html)
* changed logger to [structlog](https://www.structlog.org/)
* 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](https://github.com/msztolcman/sendria/tree/master/addons/nginx.conf)
and [supervisor](https://github.com/msztolcman/sendria/tree/master/addons/supervisor.conf)
#### Backward incompatible changes:
* all api's requests are now prefixed with `/api` (look at [API section](#api))
* `--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](https://github.com/dependabot))
### v0.1.3
* fixed layout issues (thanks [radoslawhryciow](https://github.com/radoslawhryciow))
### 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](https://docs.pipenv.org/)
* 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](https://github.com/ThiefMaster/maildump/pull/28) )
* copy from [MailDump](https://github.com/ThiefMaster/maildump) v0.5.6