mailcatcher-jruby 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db3de1ac2c71a4f2527f8fc89ca04dd393c8e7dd
+  data.tar.gz: 1d6b9017bc94386eb14694308f1557e75d388cbe
+SHA512:
+  metadata.gz: fd21fcae35b466de0d78d8fac33bfea6509903a8609122b8e3334ee0f018da3c3f5ec90629789f78167b14d5831f90dd1601c33e7e4da5ac4541d6cddb103290
+  data.tar.gz: d431ef8c32c497efa82f1604f886eb9ed118125b722841641467d8e953cec27e079117ded31064f65390a153459237e853390ab0c2e11977cb9b1e391e90c691

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 Samuel Cochran
+
+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.

data/README.md

@@ -0,0 +1,146 @@
+# MailCatcher
+
+## JRuby Support
+1. Configure rails.
+To set up your rails app, I recommend adding this to your `environment/development.rb`:
+
+    config.action_mailer.delivery_method = :smtp
+    config.action_mailer.smtp_settings = { :address => "localhost", :port => 1025 }
+
+2. Start the smpt server at port 1025
+`jruby server.rb`
+
+3. Start Puma rack server to host web pages of emails.
+`puma`
+add `-p 1080` to use port 1080
+
+Open [http://127.0.0.1:9292](http://127.0.0.1:9292) to see emails.
+
+# Original Document
+
+
+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.
+
+![MailCatcher screenshot](http://f.cl.ly/items/3w2T1p0F3g003b2i1F2z/Screen%20shot%202011-06-23%20at%2011.39.03%20PM.png)
+
+## 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)
+* Can send HTML for analysis by [Fractal][fractal].
+* 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], otherwise updates every thirty seconds.
+* Growl notifications when you receive a new message.
+* Runs as a daemon 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.
+* Keyboard navigation between messages
+
+## How
+
+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].
+
+### Bundler
+
+Please don't put mailcatcher into your Gemfile. It will conflict with your applications gems at some point.
+
+Instead, pop a note in your README stating you use mailcatcher. Simply run `gem install mailcatcher` then `mailcatcher` to get started.
+
+### RVM
+
+Under RVM your mailcatcher command may only be 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 do gem install mailcatcher
+    rvm wrapper default@mailcatcher --no-prefix mailcatcher catchmail
+
+### Rails
+
+To set up your rails app, I recommend adding this to your `environment/development.rb`:
+
+    config.action_mailer.delivery_method = :smtp
+    config.action_mailer.smtp_settings = { :address => "localhost", :port => 1025 }
+
+### PHP
+
+For projects using PHP, or PHP frameworks and application platforms like Drupal, you can set [PHP's mail configuration](http://www.php.net/manual/en/mail.configuration.php) in your [php.ini](http://www.php.net/manual/en/configuration.file.php) to send via MailCatcher with:
+
+    sendmail_path = /usr/bin/env catchmail -f some@from.address
+
+You can do this in an [Apache htaccess file](http://php.net/manual/en/configuration.changes.php) or general configuration like so:
+
+    php_value sendmail_path "/usr/bin/env catchmail -f some@from.address"
+
+If you've installed via RVM this probably won't work unless you've manually added your RVM bin paths to your system environment's PATH. In that case, run `which catchmail` and put that path into the `sendmail_path` directive above instead of `/usr/bin/env catchmail`.
+
+If starting `mailcatcher` on alternative SMTP IP and/or port with parameters like `--smtp-ip 192.168.0.1 --smtp-port 10025`, add the same parameters to your `catchmail` command:
+
+    sendmail_path = /usr/bin/env catchmail --smtp-ip 192.160.0.1 --smtp-port 10025 -f some@from.address
+
+### Django
+
+For use in Django, simply add the following configuration to your projects' settings.py
+
+```python
+if DEBUG:
+    EMAIL_HOST = '127.0.0.1'
+    EMAIL_HOST_USER = ''
+    EMAIL_HOST_PASSWORD = ''
+    EMAIL_PORT = 1025
+    EMAIL_USE_TLS = False
+```
+
+### 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][mailcatcher-issues] 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
+
+* Add mail delivery on request, optionally multiple times.
+* Better Growl support in MacRuby and RubyCocoa with click notifications which takes you to the received message.
+* An API-compatible nodejs version, for fun and profit (and non-ruby npm users).
+* Test suite.
+* Compatibility testing against CampaignMonitor's [design guidelines](http://www.campaignmonitor.com/design-guidelines/) and [CSS support matrix](http://www.campaignmonitor.com/design-guidelines/).
+* 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][tfg] for giving me the idea, being great guinea pigs and letting me steal pieces of time to keep the project alive.
+
+## Donations
+
+I work on MailCatcher mostly in my own spare time. If you've found Mailcatcher useful and would like to help feed me and fund continued development and new features, please [donate via PayPal][donate]. If you'd like a specific feature added to MailCatcher and are willing to pay for it, please [email me](mailto:sj26@sj26.com).
+
+## License
+
+Copyright © 2010-2011 Samuel Cochran (sj26@sj26.com). Released under the MIT License, see [LICENSE][license] for details.
+
+## Dreams
+
+For dream catching, try [this](http://goo.gl/kgbh). OR [THIS](http://www.nyanicorn.com), OMG.
+
+  [donate]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=522WUPLRWUSKE
+  [fractal]: http://getfractal.com
+  [license]: https://github.com/sj26/mailcatcher/blob/master/LICENSE
+  [mailcatcher-github]: https://github.com/sj26/mailcatcher
+  [mailcatcher-issues]: https://github.com/sj26/mailcatcher/issues
+  [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

data/bin/catchmail

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'mail'
+rescue LoadError
+  require 'rubygems'
+  require 'mail'
+end
+
+require 'optparse'
+
+options = {:smtp_ip => '127.0.0.1', :smtp_port => 1025}
+
+OptionParser.new do |parser|
+  parser.banner = <<-BANNER.gsub /^ +/, ""
+    Usage: catchmail [options]
+    sendmail-like interface to forward mail to MailCatcher.
+  BANNER
+
+  parser.on('--ip IP') do |ip|
+    options[:smtp_ip] = ip
+  end
+
+  parser.on('--smtp-ip IP', 'Set the ip address of the smtp server') do |ip|
+    options[:smtp_ip] = ip
+  end
+
+  parser.on('--smtp-port PORT', Integer, 'Set the port of the smtp server') do |port|
+    options[:smtp_port] = port
+  end
+
+  parser.on('-f FROM', 'Set the sending address') do |from|
+    options[:from] = from
+  end
+  
+  parser.on('-oi', 'Ignored option -oi') do |ignored|
+  end
+  parser.on('-t', 'Ignored option -t') do |ignored|
+  end
+  parser.on('-q', 'Ignored option -q') do |ignored|
+  end
+
+  parser.on('-x', '--no-exit', 'Can\'t exit from the application') do
+    options[:no_exit] = true
+  end
+
+  parser.on('-h', '--help', 'Display this help information') do
+    puts parser
+    exit!
+  end
+end.parse!
+
+Mail.defaults do
+  delivery_method :smtp,
+    :address => options[:smtp_ip],
+    :port => options[:smtp_port]
+end
+
+message = Mail.new ARGF.read
+message.return_path = options[:from] if options[:from]
+message.deliver

data/bin/mailcatcher

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'mail_catcher'
+MailCatcher.run!

data/lib/mail_catcher.rb

@@ -0,0 +1,220 @@
+require 'active_support/core_ext'
+require 'eventmachine'
+require 'open3'
+require 'optparse'
+require 'rbconfig'
+#require 'thin'
+
+require_relative 'mail_catcher/version'
+
+module MailCatcher extend self
+  def which command
+    not windows? and Open3.popen3 'which', 'command' do |stdin, stdout, stderr|
+      return stdout.read.chomp.presence
+    end
+  end
+
+  def mac?
+    RbConfig::CONFIG['host_os'] =~ /darwin/
+  end
+
+  def windows?
+    RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+  end
+
+  def macruby?
+    mac? and const_defined? :MACRUBY_VERSION
+  end
+
+  def growlnotify?
+    which "growlnotify"
+  end
+
+  def growl?
+    growlnotify?
+  end
+
+  def browse?
+    windows? or which "open"
+  end
+
+  def browse url
+    if windows?
+      system "start", "/b", url
+    elsif which "open"
+      system "open", url
+    end
+  end
+
+  @@defaults = {
+    :smtp_ip => '0.0.0.0',
+    :smtp_port => '9000',
+    :http_ip => '127.0.0.1',
+    :http_port => '1080',
+    :verbose => false,
+    :daemon => false,
+    #:daemon => !windows?,
+    :growl => growlnotify?,
+    :browse => false,
+    :quit => true,
+  }
+
+  def options
+    @@options rescue @@defaults
+  end
+
+  def quittable?
+    options[:quit]
+  end
+
+  def parse! arguments=ARGV, defaults=@defaults
+    @@defaults.dup.tap do |options|
+      OptionParser.new do |parser|
+        parser.banner = "Usage: mailcatcher [options]"
+        parser.version = VERSION
+
+        parser.on("--ip IP", "Set the ip address of both servers") do |ip|
+          options[:smtp_ip] = options[:http_ip] = ip
+        end
+
+        parser.on("--smtp-ip IP", "Set the ip address of the smtp server") do |ip|
+          options[:smtp_ip] = ip
+        end
+
+        parser.on("--smtp-port PORT", Integer, "Set the port of the smtp server") do |port|
+          options[:smtp_port] = port
+        end
+
+        parser.on("--http-ip IP", "Set the ip address of the http server") do |ip|
+          options[:http_ip] = ip
+        end
+
+        parser.on("--http-port PORT", Integer, "Set the port address of the http server") do |port|
+          options[:http_port] = port
+        end
+
+        parser.on("--no-quit", "Don't allow quitting the process") do
+          options[:quit] = false
+        end
+
+        if mac?
+          parser.on("--[no-]growl", "Growl to the local machine when a message arrives") do |growl|
+            if growl and not growlnotify?
+              puts "You'll need to install growlnotify from the Growl installer."
+              puts
+              puts "See: http://growl.info/extras.php#growlnotify"
+              exit -2
+            end
+
+            options[:growl] = growl
+          end
+        end
+
+        unless windows?
+          parser.on('-f', '--foreground', 'Run in the foreground') do
+            options[:daemon] = false
+          end
+        end
+
+        if browse?
+          parser.on('-b', '--browse', 'Open web browser') do
+            options[:browse] = true
+          end
+        end
+
+        parser.on('-v', '--verbose', 'Be more verbose') do
+          options[:verbose] = true
+        end
+
+        parser.on('-h', '--help', 'Display this help information') do
+          puts parser
+          exit
+        end
+      end.parse!
+    end
+  end
+
+  def run! options=nil
+    # If we are passed options, fill in the blanks
+    options &&= options.reverse_merge @@defaults
+    # Otherwise, parse them from ARGV
+    options ||= parse!
+
+    # Stash them away for later
+    @@options = options
+
+    puts "Starting MailCatcher"
+
+    #Thin::Logging.silent = true
+
+    # One EventMachine loop...
+    EventMachine.run do
+      # Get our lion on if asked
+      MailCatcher::Growl.start if options[:growl]
+
+      smtp_url = "smtp://#{options[:smtp_ip]}:#{options[:smtp_port]}"
+      http_url = "http://#{options[:http_ip]}:#{options[:http_port]}"
+
+      # Set up an SMTP server to run within EventMachine
+      rescue_port options[:smtp_port] do
+        EventMachine.start_server options[:smtp_ip], options[:smtp_port], Smtp
+        puts "==> #{smtp_url}"
+      end
+
+      # Let Thin set itself up inside our EventMachine loop
+      # (Skinny/WebSockets just works on the inside)
+      # rescue_port options[:http_port] do
+        #Thin::Server.start options[:http_ip], options[:http_port], Web
+        # puts "==> #{http_url}"
+      # end
+
+      # Open the web browser before detatching console
+      if options[:browse]
+        EventMachine.next_tick do
+          browse http_url
+        end
+      end
+
+      # Daemonize, if we should, but only after the servers have started.
+      if options[:daemon]
+        EventMachine.next_tick do
+          if quittable?
+            puts "*** MailCatcher runs as a daemon by default. Go to the web interface to quit."
+          else
+            puts "*** MailCatcher is now running as a daemon that cannot be quit."
+          end
+          #Process.daemon
+        end
+      end
+    end
+  end
+
+  def quit!
+    EventMachine.next_tick { EventMachine.stop_event_loop }
+  end
+
+protected
+
+  def rescue_port port
+    begin
+      yield
+
+    # XXX: EventMachine only spits out RuntimeError with a string description
+    rescue RuntimeError
+      if $!.to_s =~ /\bno acceptor\b/
+        puts "~~> ERROR: Something's using port #{port}. Are you already running MailCatcher?"
+        exit -1
+      else
+        raise
+      end
+    end
+  end
+end
+
+require_relative 'mail_catcher/events'
+require_relative 'mail_catcher/growl'
+require_relative 'mail_catcher/mail'
+require_relative 'mail_catcher/smtp'
+require_relative 'mail_catcher/web'
+
+# MailCatcher.run!