mirror of https://github.com/moparisthebest/mailcatcher synced 2024-12-22 15:28:52 -05:00

Go to file

Samuel Cochran 6b1f3e343d Process.daemon doesn't work on Windows		2011-06-01 22:04:45 +08:00
bin	Add catchmail, a sendmail-analogue for deliverying to MailCatcher via SMTP.	2011-05-29 12:40:14 +08:00
lib	Process.daemon doesn't work on Windows	2011-06-01 22:04:45 +08:00
public	Clear all mail.	2011-06-01 01:15:05 +08:00
views	Refactoring with compass, hooray!	2011-06-01 00:40:13 +08:00
.gitignore	Ignore generated gems and rdoc	2011-05-27 20:38:39 +08:00
Gemfile	Bundler for development pulling from Gemfile, no dist.	2011-05-27 21:47:43 +08:00
Gemfile.lock	Version 0.4.0	2011-06-01 01:36:14 +08:00
Guardfile	Guard makes everything easier.	2011-05-29 21:32:38 +08:00
LICENSE	Update LICENSE year	2011-05-31 06:48:57 -07:00
mailcatcher.gemspec	Refactoring with compass, hooray!	2011-06-01 00:40:13 +08:00
Rakefile	Add coffee-script.	2011-05-29 14:46:28 +08:00
README.md	A screenshot showing an actual message might be nice.	2011-06-01 02:07:29 +08:00
VERSION	Version 0.4.0	2011-06-01 01:36:14 +08:00

README.md

MailCatcher

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.

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.
Runs as a daemon run in the background.
Sendmail-analogue command, catchmail, makes using mailcatcher from PHP a lot easier.
Written super-simply in EventMachine, easy to dig in and change.

How

gem install mailcatcher
mailcatcher
Go to http://localhost:1080/
Send mail through smtp://localhost:1025

The brave can get the source from the GitHub repository.

RVM

Under RVM your mailcatcher command may only available under the ruby you install mailcatcher into. To prevent this, and to prevent gem conflicts, install mailcatcher into a dedicated gemset and create wrapper scripts:

rvm default@mailcatcher --create gem install mailcatcher
rvm wrapper default@mailcatcher --no-prefix mailcatcher catchmail

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.

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.
Test suite.
Add mail delivery on request, optionally multiple times.
Forward mail to rendering service, maybe CampaignMonitor?
Package as an app? Native interfaces? HotCocoa?

Thanks

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 for giving me the idea, being great guinea pigs and letting me steal pieces of time to keep the project alive.

Copyright

Dreams

For dream catching, try this. OR THIS, OMG.