Skip to content

Commit

Permalink
README changes.
Browse files Browse the repository at this point in the history
Re-order, copyright, thanks to TFG, PHP feature,
  • Loading branch information
sj26 committed May 31, 2011
1 parent ac6a439 commit bcdf166
Showing 1 changed file with 24 additions and 15 deletions.
39 changes: 24 additions & 15 deletions README.md
Expand Up @@ -6,29 +6,27 @@ MailCatcher runs a super simple SMTP server which catches any message sent to it

![MailCatcher screenshot](http://puu.sh/2fZR)

## How

1. `gem install mailcatcher`
2. `mailcatcher`
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.
* 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.

## Caveats
## How

* 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.
1. `gem install mailcatcher`
2. `mailcatcher`
3. Go to http://localhost:1080/
4. Send mail through smtp://localhost:1025

The brave can get the source from [the GitHub repository][mailcatcher-github].

## RVM

Expand All @@ -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.
Expand All @@ -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

0 comments on commit bcdf166

Please sign in to comment.