Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Add some project info and licensing

  • Loading branch information...
commit 840699d20c7dce649d06ce1206196ed9b23c642b 1 parent 699edba
@sj26 authored
Showing with 55 additions and 0 deletions.
  1. +19 −0 LICENSE
  2. +36 −0 README.md
View
19 LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2010 Samuel Cochran <sj26@sj26.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
View
36 README.md
@@ -0,0 +1,36 @@
+# 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.
+
+## Caveats
+
+* 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.
+* Download link to view original message in mail client.
+* Test suite.
+* Better organisation.
+* Better interface. SproutCore?
+* Add mail delivery on request, optionally multiple times.
+* Forward mail to rendering service, maybe CampaignMonitor?
+
+## License
+
+MailCatcher is released under the MIT License. See LICENSE.
+
+## Dreams
+
+For dream catching, try [this](http://goo.gl/kgbh).
Please sign in to comment.
Something went wrong with that request. Please try again.