mailcatcher 0.5.12 → 0.6.0pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 087ab236a57889861232c36337622a2c491f015e
-  data.tar.gz: 2025e9693e21dae93e87d28261ae520ea3b1d4f8
+  metadata.gz: 20a21ec3f69fd47bbc8c269689998ace77da0c1b
+  data.tar.gz: f55e1936c3fb237909fb0bf1bc1282af1c709175
 SHA512:
-  metadata.gz: 96f670bb993dc0f567da90089a88effdec7ec1f4fcd30d85e7f0d63a9ee18446f4edd0b6ebbb48a3062d0f7bd0cfb9fe41cfd0edea05d53864cfc5930b034121
-  data.tar.gz: 42daf4cd55e174e109c08c041261ac3cd5597b57fdcb5a6e632a31e838f8a4b7f828a24871e18833aa5de6635848065d150ee93f7eaab3f9aef0df0ed6f19b31
+  metadata.gz: 693e35eb5cec71175f37e7c7c57a08a591985a65284c71c4a8684e7c020114f9f7733b522f6df404fca1ba5a922b098836fb7b02497ed25e93ca834b06f3d216
+  data.tar.gz: 8e474863a1a3bd887322bb4b9007aba2c14a44d5a3b783cc3384adc5df7ca1f89d07df069e0ed040a8315d47791568b22fc05fff54dbdcf15633308ea4fed0ba

data/README.md

@@ -10,13 +10,11 @@ MailCatcher runs a super simple SMTP server which catches any message sent to it
 
 * 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].
+* Rewrites HTML enabling display of embedded, inline images/etc and open links in a new window.
 * 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.
@@ -29,7 +27,7 @@ MailCatcher runs a super simple SMTP server which catches any message sent to it
 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].
+Use `mailcatcher --help` to see the command line options. The brave can get the source from [the GitHub repository][mailcatcher-github].
 
 ### Bundler
 
@@ -46,7 +44,7 @@ Under RVM your mailcatcher command may only be available under the ruby you inst
 
 ### Rails
 
-To set up your rails app, I recommend adding this to your `environment/development.rb`:
+To set up your rails app, I recommend adding this to your `environments/development.rb`:
 
     config.action_mailer.delivery_method = :smtp
     config.action_mailer.smtp_settings = { :address => "localhost", :port => 1025 }
@@ -55,14 +53,31 @@ To set up your rails app, I recommend adding this to your `environment/developme
 
 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
+    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:
+You can do this in your [Apache configuration](http://php.net/manual/en/configuration.changes.php) like so:
 
-    php_value sendmail_path "/usr/bin/env catchmail"
+    php_admin_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`.
@@ -75,10 +90,9 @@ A fairly RESTful URL schema means you can download a list of messages in JSON fr
 ## 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/).
+* Compatibility testing against CampaignMonitor's [design guidelines](http://www.campaignmonitor.com/design-guidelines/) and [CSS support matrix](http://www.campaignmonitor.com/css/).
 * Forward mail to rendering service, maybe CampaignMonitor?
 * Package as an app? Native interfaces? HotCocoa?
 
@@ -101,7 +115,6 @@ Copyright © 2010-2011 Samuel Cochran (sj26@sj26.com). Released under the MIT Li
 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

data/bin/catchmail

@@ -13,7 +13,7 @@ options = {:smtp_ip => '127.0.0.1', :smtp_port => 1025}
 
 OptionParser.new do |parser|
   parser.banner = <<-BANNER.gsub /^ +/, ""
-    Usage: catchmail [options]
+    Usage: catchmail [options] [recipient ...]
     sendmail-like interface to forward mail to MailCatcher.
   BANNER
 
@@ -33,6 +33,17 @@ OptionParser.new do |parser|
     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!
@@ -45,6 +56,16 @@ Mail.defaults do
     :port => options[:smtp_port]
 end
 
-message = Mail.new ARGF.read
+message = Mail.new($stdin.read)
+
 message.return_path = options[:from] if options[:from]
+
+ARGV.each do |recipient|
+  if message.to.nil?
+    message.to = recipient
+  else
+    message.to << recipient
+  end
+end
+
 message.deliver

data/bin/mailcatcher

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

data/lib/mail_catcher.rb

@@ -1,14 +1,19 @@
-require 'active_support/core_ext'
-require 'eventmachine'
-require 'open3'
-require 'optparse'
-require 'rbconfig'
-require 'thin'
+require "open3"
+require "optparse"
+require "rbconfig"
 
-require 'mail_catcher/version'
+require "active_support/all"
+require "eventmachine"
+require "thin"
+
+require "mail_catcher/events"
+require "mail_catcher/mail"
+require "mail_catcher/smtp"
+require "mail_catcher/web"
+require "mail_catcher/version"
 
 module MailCatcher extend self
-  def which command
+  def which(command)
     not windows? and Open3.popen3 'which', 'command' do |stdin, stdout, stderr|
       return stdout.read.chomp.presence
     end
@@ -26,14 +31,6 @@ module MailCatcher extend self
     mac? and const_defined? :MACRUBY_VERSION
   end
 
-  def growlnotify?
-    which "growlnotify"
-  end
-
-  def growl?
-    growlnotify?
-  end
-
   def browse?
     windows? or which "open"
   end
@@ -46,19 +43,27 @@ module MailCatcher extend self
     end
   end
 
-  @defaults = {
+  @@defaults = {
     :smtp_ip => '127.0.0.1',
     :smtp_port => '1025',
     :http_ip => '127.0.0.1',
     :http_port => '1080',
     :verbose => false,
     :daemon => !windows?,
-    :growl => growlnotify?,
     :browse => false,
+    :quit => true,
   }
 
+  def options
+    @@options
+  end
+
+  def quittable?
+    options[:quit]
+  end
+
   def parse! arguments=ARGV, defaults=@defaults
-    @defaults.dup.tap do |options|
+    @@defaults.dup.tap do |options|
       OptionParser.new do |parser|
         parser.banner = "Usage: mailcatcher [options]"
         parser.version = VERSION
@@ -83,16 +88,14 @@ module MailCatcher extend self
           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!
-            end
-
-            options[:growl] = growl
+          parser.on("--[no-]growl") do |growl|
+            puts "Growl is no longer supported"
+            exit -2
           end
         end
 
@@ -114,7 +117,7 @@ module MailCatcher extend self
 
         parser.on('-h', '--help', 'Display this help information') do
           puts parser
-          exit!
+          exit
         end
       end.parse!
     end
@@ -122,19 +125,24 @@ module MailCatcher extend self
 
   def run! options=nil
     # If we are passed options, fill in the blanks
-    options &&= @defaults.merge options
+    options &&= options.reverse_merge @@defaults
     # Otherwise, parse them from ARGV
     options ||= parse!
 
+    # Stash them away for later
+    @@options = options
+
+    # If we're running in the foreground sync the output.
+    unless options[:daemon]
+      $stdout.sync = $stderr.sync = true
+    end
+
     puts "Starting MailCatcher"
 
-    Thin::Logging.silent = true
+    Thin::Logging.silent = (ENV["MAILCATCHER_ENV"] != "development")
 
     # 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]}"
 
@@ -147,7 +155,7 @@ module MailCatcher extend self
       # 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
+        Thin::Server.start(options[:http_ip], options[:http_port], Web)
         puts "==> #{http_url}"
       end
 
@@ -161,7 +169,11 @@ module MailCatcher extend self
       # Daemonize, if we should, but only after the servers have started.
       if options[:daemon]
         EventMachine.next_tick do
-          puts "*** MailCatcher runs as a daemon by default. Go to the web interface to quit."
+          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
@@ -182,16 +194,10 @@ protected
     rescue RuntimeError
       if $!.to_s =~ /\bno acceptor\b/
         puts "~~> ERROR: Something's using port #{port}. Are you already running MailCatcher?"
-        exit(-1)
+        exit -1
       else
         raise
       end
     end
   end
 end
-
-require 'mail_catcher/events'
-require 'mail_catcher/growl'
-require 'mail_catcher/mail'
-require 'mail_catcher/smtp'
-require 'mail_catcher/web'

data/lib/mail_catcher/events.rb

@@ -1,5 +1,7 @@
-require 'eventmachine'
+require "eventmachine"
 
-module MailCatcher::Events
-  MessageAdded = EventMachine::Channel.new
+module MailCatcher
+  module Events
+    MessageAdded = EventMachine::Channel.new
+  end
 end

data/lib/mail_catcher/mail.rb

@@ -1,12 +1,12 @@
-require 'active_support/json'
-require 'mail'
-require 'sqlite3'
-require 'eventmachine'
+require "active_support/json"
+require "eventmachine"
+require "mail"
+require "sqlite3"
 
 module MailCatcher::Mail extend self
   def db
     @__db ||= begin
-      SQLite3::Database.new(':memory:', :type_translation => true).tap do |db|
+      SQLite3::Database.new(":memory:", :type_translation => true).tap do |db|
         db.execute(<<-SQL)
           CREATE TABLE message (
             id INTEGER PRIMARY KEY ASC,
@@ -41,7 +41,7 @@ module MailCatcher::Mail extend self
     @add_message_query ||= db.prepare("INSERT INTO message (sender, recipients, subject, source, type, size, created_at) VALUES (?, ?, ?, ?, ?, ?, datetime('now'))")
 
     mail = Mail.new(message[:source])
-    @add_message_query.execute(message[:sender], message[:recipients].to_json, mail.subject, message[:source], mail.mime_type || 'text/plain', message[:source].length)
+    @add_message_query.execute(message[:sender], message[:recipients].to_json, mail.subject, message[:source], mail.mime_type || "text/plain", message[:source].length)
     message_id = db.last_insert_row_id
     parts = mail.all_parts
     parts = [mail] if parts.empty?
@@ -49,7 +49,7 @@ module MailCatcher::Mail extend self
       body = part.body.to_s
       # Only parts have CIDs, not mail
       cid = part.cid if part.respond_to? :cid
-      add_message_part(message_id, cid, part.mime_type || 'text/plain', part.attachment? ? 1 : 0, part.filename, part.charset, body, body.length)
+      add_message_part(message_id, cid, part.mime_type || "text/plain", part.attachment? ? 1 : 0, part.filename, part.charset, body, body.length)
     end
 
     EventMachine.next_tick do
@@ -69,7 +69,7 @@ module MailCatcher::Mail extend self
   end
 
   def messages
-    @messages_query ||= db.prepare "SELECT id, sender, recipients, subject, size, created_at FROM message ORDER BY created_at DESC"
+    @messages_query ||= db.prepare "SELECT id, sender, recipients, subject, size, created_at FROM message ORDER BY created_at, id ASC"
     @messages_query.execute.map do |row|
       Hash[row.fields.zip(row)].tap do |message|
         message["recipients"] &&= ActiveSupport::JSON.decode message["recipients"]
@@ -87,7 +87,7 @@ module MailCatcher::Mail extend self
 
   def message_has_html?(id)
     @message_has_html_query ||= db.prepare "SELECT 1 FROM message_part WHERE message_id = ? AND is_attachment = 0 AND type IN ('application/xhtml+xml', 'text/html') LIMIT 1"
-    (!!@message_has_html_query.execute(id).next) || ['text/html', 'application/xhtml+xml'].include?(message(id)["type"])
+    (!!@message_has_html_query.execute(id).next) || ["text/html", "application/xhtml+xml"].include?(message(id)["type"])
   end
 
   def message_has_plain?(id)
@@ -126,7 +126,7 @@ module MailCatcher::Mail extend self
     part ||= message_part_type(message_id, "application/xhtml+xml")
     part ||= begin
       message = message(message_id)
-      message if message.present? and ['text/html', 'application/xhtml+xml'].include? message["type"]
+      message if message.present? and ["text/html", "application/xhtml+xml"].include? message["type"]
     end
   end
 
@@ -135,7 +135,7 @@ module MailCatcher::Mail extend self
   end
 
   def message_part_cid(message_id, cid)
-    @message_part_cid_query ||= db.prepare 'SELECT * FROM message_part WHERE message_id = ?'
+    @message_part_cid_query ||= db.prepare "SELECT * FROM message_part WHERE message_id = ?"
     @message_part_cid_query.execute(message_id).map do |row|
       Hash[row.fields.zip(row)]
     end.find do |part|
@@ -144,16 +144,16 @@ module MailCatcher::Mail extend self
   end
 
   def delete!
-    @delete_messages_query ||= db.prepare 'DELETE FROM message'
-    @delete_message_parts_query ||= db.prepare 'DELETE FROM message_part'
+    @delete_messages_query ||= db.prepare "DELETE FROM message"
+    @delete_message_parts_query ||= db.prepare "DELETE FROM message_part"
 
     @delete_messages_query.execute and
     @delete_message_parts_query.execute
   end
 
   def delete_message!(message_id)
-    @delete_messages_query ||= db.prepare 'DELETE FROM message WHERE id = ?'
-    @delete_message_parts_query ||= db.prepare 'DELETE FROM message_part WHERE message_id = ?'
+    @delete_messages_query ||= db.prepare "DELETE FROM message WHERE id = ?"
+    @delete_message_parts_query ||= db.prepare "DELETE FROM message_part WHERE message_id = ?"
     @delete_messages_query.execute(message_id) and
     @delete_message_parts_query.execute(message_id)
   end

data/lib/mail_catcher/smtp.rb

@@ -1,4 +1,6 @@
-require 'eventmachine'
+require "eventmachine"
+
+require "mail_catcher/mail"
 
 class MailCatcher::Smtp < EventMachine::Protocols::SmtpServer
   # We override EM's mail from processing to allow multiple mail-from commands
@@ -34,7 +36,9 @@ class MailCatcher::Smtp < EventMachine::Protocols::SmtpServer
 
   def receive_data_chunk(lines)
     current_message[:source] ||= ""
-    current_message[:source] << lines.join("\n")
+    lines.each do |line|
+      current_message[:source] << line << "\r\n"
+    end
     true
   end
 

data/lib/mail_catcher/version.rb

@@ -1,3 +1,3 @@
 module MailCatcher
-  VERSION = "0.5.12"
+  VERSION = "0.6.0pre1"
 end