moparisthebest
/
mailcatcher
mirror of https://github.com/moparisthebest/mailcatcher
1
0
Fork 0
Code Issues Releases Wiki Activity

README changes. 

Re-order, copyright, thanks to TFG, PHP feature,
This commit is contained in:
Samuel Cochran 2011-05-31 06:48:15 -07:00
parent ac6a439796
commit bcdf16680a
1 changed files with 28 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -6,6 +6,19 @@ MailCatcher runs a super simple SMTP server which catches any message sent to it
![MailCatcher screenshot](http://puu.sh/2fZR)
## Features
* Catches all mail and stores it for display.
* Shows HTML, Plain Text and Source version of messages, as applicable.
* Rewrites HTML enabling display of embedded, inline images/etc and open links in a new window. (currently very basic)
* Lists attachments and allows separate downloading of parts.
* Download original email to view in your native mail client(s).
* Command line options to override the default SMTP/HTTP IP and port settings.
* Mail appears instantly if your browser supports [WebSockets][websockets].
* Daemonizable to run in the background.
* Sendmail-analogue command, `catchmail`, makes [using mailcatcher from PHP][withphp] a lot easier.
* Written super-simply in EventMachine, easy to dig in and change.
## How
1. `gem install mailcatcher`
@ -13,22 +26,7 @@ MailCatcher runs a super simple SMTP server which catches any message sent to it
3. Go to http://localhost:1080/
4. Send mail through smtp://localhost:1025
## Features
* Catches all mail and stores it for display.
* Shows HTML, Plain Text and Source version of messages, as applicable.
* Download original email to view in your native mail client(s).
* Rewrites HTML enabling display of embedded, inline images/etc and open links in a new window. (currently very basic)
* Lists attachments and allows separate downloading of parts.
* Written super-simply in EventMachine, easy to dig in and change.
* Command line options to override the default SMTP/HTTP IP and port settings.
* Mail appears instantly if your browser supports [WebSockets][websockets].
* Daemonizable to run in the background.
## Caveats
* 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.
The brave can get the source from [the GitHub repository][mailcatcher-github].
## RVM
@ -41,6 +39,11 @@ Under RVM your mailcatcher command may only available under the ruby you install
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`.
## Caveats
* 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.
## TODO
* Growl support.
@ -53,12 +56,18 @@ A fairly RESTful URL schema means you can download a list of messages in JSON fr
MailCatcher is just a mishmash of other people's hard work. Thank you so much to the people who have built the wonderful guts on which this project relies.
Thanks also to [The Frontier Group][tfg] for giving me the idea, being great guinea pigs and letting me steal pieces of time to keep the project alive.
## Copyright
Copyright (c) 2010 Samuel Cochran. See LICENSE for details.
Copyright © 2010-2011 Samuel Cochran. See [LICENSE][license] for details.
## Dreams
For dream catching, try [this](http://goo.gl/kgbh).
For dream catching, try [this](http://goo.gl/kgbh). OR [THIS](http://www.nyanicorn.com), OMG.
[websockets]: http://www.whatwg.org/specs/web-socket-protocol/
[license]: https://github.com/sj26/mailcatcher/blob/master/LICENSE
[mailcatcher-github]: https://github.com/sj26/mailcatcher
[tfg]: http://www.thefrontiergroup.com.au
[websockets]: http://www.whatwg.org/specs/web-socket-protocol/
[withphp]: http://webschuur.com/publications/blogs/2011-05-29-catchmail_for_drupal_and_other_phpapplications_the_simple_version