3 releases
0.9.3 | Jan 12, 2022 |
---|---|
0.9.2 | Jan 10, 2022 |
0.9.1 | Jul 26, 2021 |
#1049 in Development tools
47KB
1K
SLoC
Tiny MailCatcher
Tiny MailCatcher is a tiny (<6 MB) drop-in MailCatcher replacement optimized for size and speed. It's meant to be run in a resource constrained environment, such as a CI system, or as part of an automated test suite.
Some features that the original MailCatcher has were omitted: Tiny MailCatcher does not have an HTML + JavaScript UI and it does not publish a WebSocket endpoint at /messages (yet). If you need either of these features I strongly recommend installing the original MailCatcher.
When Tiny MailCatcher is running any emails sent to port 1025 (configurable) can be accessed and analysed via a REST API. This is useful in a test suite when asserting that certain emails are or are not sent.
Documentation
The documentation at https://mailcatcher.me/ also applies to Tiny MailCatcher.
In short:
- Tiny MailCatcher has an SMTP server which runs on port 1025 by default (configurable)
- There is a REST API that runs on port 1080 (configurable).
GET/DELETE http://localhost:1080/messages
retrieves/deletes all messagesGET http://localhost:1080/messages/:id
retrieve a single message in JSON formatGET http://localhost:1080/messages/:id.source
retrieve the message sourceGET http://localhost:1080/messages/:id.html
retrieve the HTML version of this messageGET http://localhost:1080/messages/:id.eml
retrieve the EML version of this messageGET http://localhost:1080/messages/:id.plain
retrieve the text/plain version of this messageDELETE http://localhost:1080/messages/:id
delete a messageGET http://localhost:1080/messages/:id/parts/:cid
retrieve attachments by content ID
Installation
Using Cargo:
cargo install tiny-mailcatcher
There is also a tiny (~5MB) Docker image available:
docker run -d -p 1080:80 -p 1025:25 pevdh/tiny-mailcatcher:latest
Usage
USAGE:
tiny-mailcatcher [OPTIONS]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
--http-port <http-port> [default: 1080]
--ip <ip> [default: 127.0.0.1]
--smtp-port <smtp-port> [default: 1025]
Dependencies
~15–26MB
~420K SLoC