moparisthebest/mailcatcher
1
0
Fork 0
mirror of https://github.com/moparisthebest/mailcatcher synced 2024-12-22 15:28:52 -05:00
Code Issues Releases Wiki Activity

Merge remote-tracking branch 'refs/remotes/origin/master'

Browse Source
This commit is contained in:
Samuel Cochran 2011-05-27 12:48:06 +08:00
commit b4ad9041c3
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -4,6 +4,8 @@ Catches mail and serves it through a dream.
MailCatcher runs a super simple SMTP server which catches any message sent to it to display in a web interface. Run mailcatcher, set your favourite app to deliver to smtp://127.0.0.1:1025 instead of your default SMTP server, then check out http://127.0.0.1:1080 to see the mail that's arrived so far.
![MailCatcher screenshot](http://puu.sh/25jm)
## How
1. `gem install mailcatcher`
@ -27,6 +29,10 @@ MailCatcher runs a super simple SMTP server which catches any message sent to it
* Mail processing is fairly basic but easily modified. If something doesn't work for you, fork and fix it or file an issue and let me know. Include the whole message you're having problems with.
* The interface is very basic and has not been tested on many browsers yet.
## API
A fairly RESTful URL schema means you can download a list of messages in JSON from `/messages`, each message's metadata with `/messages/:id.json`, and then the pertinent parts with `/messages/:id.html` and `/messages/:id.plain` for the default HTML and plain text version, `/messages/:id/:cid` for individual attachments by CID, or the whole message with `/messages/:id.source`.
## TODO
* Download link to view original message in mail client.