moparisthebest
/
mailcatcher
mirror of https://github.com/moparisthebest/mailcatcher
1
0
Fork 0
Code Issues Releases Wiki Activity
15 Commits 4 Branches 34 Tags 1.4 MiB
Ruby 62.8%
CoffeeScript 22%
CSS 10.6%
HTML 4.3%
Dockerfile 0.3%
Go to file
Samuel Cochran 9bd4356633 Version bump. 2010-10-25 23:33:40 +08:00
bin Adding command line options from amc-projects/mailcatcher@f7a1b2f6ef, thanks to schlick. 2010-10-25 23:32:56 +08:00
lib Adding command line options from amc-projects/mailcatcher@f7a1b2f6ef, thanks to schlick. 2010-10-25 23:32:56 +08:00
views A publically-accessible jQuery might be nice 2010-10-25 10:31:29 +08:00
Gemfile Forgot to include haml in dependencies. >.< 2010-10-25 23:33:35 +08:00
LICENSE Add some project info and licensing 2010-10-25 09:23:40 +08:00
README.md Adding command line options from amc-projects/mailcatcher@f7a1b2f6ef, thanks to schlick. 2010-10-25 23:32:56 +08:00
mailcatcher.gemspec Version bump. 2010-10-25 23:33:40 +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. (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.

Caveats

  • Mail requires activesupport which requires i18n, but it doesn't list it as a dependency. For now I've added i18n as a requirement for MailCatcher.
  • For now you need to refresh the page to see new mail. Websockets support is coming soon to show new mail immediately.
  • Mail proccessing 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

  • Websockets for immediate mail viewing.
  • Download link to view original message in mail client.
  • Growl support.
  • Test suite.
  • Better organisation.
  • Better interface. SproutCore?
  • Add mail delivery on request, optionally multiple times.
  • Forward mail to rendering service, maybe CampaignMonitor?
  • Package as an app? Native interfaces?

License

MailCatcher is released under the MIT License. See LICENSE.

Dreams

For dream catching, try this.