mailcatcher 0.7.0 → 0.8.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d55ed5f9b9d7ae94f7fc71297726c6ba3d800eb6ff95f3cb15ae33dfbb278a9e
-  data.tar.gz: cfb1fb234b49b9b7e0bd98a6513406494d36b179f80ac3d92b09cf2f6dc29420
+  metadata.gz: ccfb98c689953785fe9c132ac154e90f2fcf5ead0c433de7611b64c1f7f89b98
+  data.tar.gz: 0c87d50eece53958f858966c9f607bef6bb885dbf0a4df9938bf4b5f5616900d
 SHA512:
-  metadata.gz: 2c8fd76e50fe31dfb042fb8abe59b50485df2e52f06813f2651d2acd41aeca3a4ede8ffc375a02d4cad1ba50af89028f022dc38ed78a6cdaddd2bd0ad2f9cee7
-  data.tar.gz: 218dfdc17255c5a86a4674742831b134ca9fdb5147e19db3ae1b6dac6a251dcfb8a8abbe9b8475bbab20b95bef248cfe40b06dc233218a1169e8873a83451338
+  metadata.gz: a1b0fae5875ae31b39700d0df1fd08c04b87ea2cd20cd7c45799c456af7cc2e4c9f4a2fc5e366b1f9ff24e0e35355752b7349fc8c991cebd8f1a664b159f2ddc
+  data.tar.gz: 4f051455ddc9718c69450318b8420bd74f7d7acea1d20fb42be18751b3c537f73b38550f807a6a0ead01544b9d84b288a7a7a77e2856ad0e782337dfa21706fc

data/README.md

@@ -26,7 +26,41 @@ MailCatcher runs a super simple SMTP server which catches any message sent to it
 3. Go to http://127.0.0.1:1080/
 4. Send mail through smtp://127.0.0.1:1025
 
-Use `mailcatcher --help` to see the command line options. The brave can get the source from [the GitHub repository][mailcatcher-github].
+### Command Line Options
+
+Use `mailcatcher --help` to see the command line options.
+
+```
+Usage: mailcatcher [options]
+        --ip IP                      Set the ip address of both servers
+        --smtp-ip IP                 Set the ip address of the smtp server
+        --smtp-port PORT             Set the port of the smtp server
+        --http-ip IP                 Set the ip address of the http server
+        --http-port PORT             Set the port address of the http server
+        --http-path PATH             Add a prefix to all HTTP paths
+        --no-quit                    Don't allow quitting the process
+    -f, --foreground                 Run in the foreground
+    -b, --browse                     Open web browser
+    -v, --verbose                    Be more verbose
+    -h, --help                       Display this help information
+```
+
+### Ruby
+
+If you have trouble with the setup commands, make sure you have [Ruby installed](https://www.ruby-lang.org/en/documentation/installation/):
+
+```
+ruby -v
+gem environment
+```
+
+You might need to install build tools for some of the gem dependencies. On Debian or Ubuntu, `apt install build-essential`. On macOS, `xcode-select --install`.
+
+If you encounter issues installing [thin](https://rubygems.org/gems/thin), try:
+
+```
+gem install thin -v 1.5.1 -- --with-cflags="-Wno-error=implicit-function-declaration"
+```
 
 ### Bundler
 
@@ -51,11 +85,11 @@ To set up your rails app, I recommend adding this to your `environments/developm
 
 ### 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:
+For projects using PHP, or PHP frameworks and application platforms like Drupal, you can set [PHP's mail configuration](https://www.php.net/manual/en/mail.configuration.php) in your [php.ini](https://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 your [Apache configuration](http://php.net/manual/en/configuration.changes.php) like so:
+You can do this in your [Apache configuration](https://www.php.net/manual/en/configuration.changes.php) like so:
 
     php_admin_value sendmail_path "/usr/bin/env catchmail -f some@from.address"
 
@@ -85,13 +119,7 @@ A fairly RESTful URL schema means you can download a list of messages in JSON fr
 ## 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.
-* 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?
+* Encodings are difficult. MailCatcher does not completely support utf-8 straight over the wire, you must use a mail library which encodes things properly based on SMTP server capabilities.
 
 ## Thanks
 
@@ -103,10 +131,10 @@ I work on MailCatcher mostly in my own spare time. If you've found Mailcatcher u
 
 ## License
 
-Copyright © 2010-2018 Samuel Cochran (sj26@sj26.com). Released under the MIT License, see [LICENSE][license] for details.
+Copyright © 2010-2019 Samuel Cochran (sj26@sj26.com). Released under the MIT License, see [LICENSE][license] for details.
 
   [donate]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=522WUPLRWUSKE
   [license]: https://github.com/sj26/mailcatcher/blob/master/LICENSE
   [mailcatcher-github]: https://github.com/sj26/mailcatcher
   [mailcatcher-issues]: https://github.com/sj26/mailcatcher/issues
-  [websockets]: http://www.whatwg.org/specs/web-socket-protocol/
+  [websockets]: https://tools.ietf.org/html/rfc6455

data/bin/catchmail

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 begin
   require 'mail'

data/bin/mailcatcher

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'mail_catcher'
 

data/lib/mail_catcher.rb

@@ -1,12 +1,4 @@
-# Apparently rubygems won't activate these on its own, so here we go. Let's
-# repeat the invention of Bundler all over again.
-gem "eventmachine", "1.0.9.1"
-gem "mail", "~> 2.3"
-gem "rack", "~> 1.5"
-gem "sinatra", "~> 1.2"
-gem "sqlite3", "~> 1.3"
-gem "thin", "~> 1.5.0"
-gem "skinny", "~> 0.2.3"
+# frozen_string_literal: true
 
 require "open3"
 require "optparse"
@@ -26,7 +18,7 @@ end
 require "mail_catcher/version"
 
 module MailCatcher extend self
-  autoload :Events, "mail_catcher/events"
+  autoload :Bus, "mail_catcher/bus"
   autoload :Mail, "mail_catcher/mail"
   autoload :Smtp, "mail_catcher/smtp"
   autoload :Web, "mail_catcher/web"
@@ -45,18 +37,10 @@ module MailCatcher extend self
     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 browseable?
     windows? or which? "open"
   end
@@ -77,7 +61,7 @@ module MailCatcher extend self
     puts "*** #{message}: #{context.inspect}"
     puts "    Exception: #{exception}"
     puts "    Backtrace:", *exception.backtrace.map { |line| "       #{line.sub(gems_regexp, gems_replace)}" }
-    puts "    Please submit this as an issue at http://github.com/sj26/mailcatcher/issues"
+    puts "    Please submit this as an issue at https://github.com/sj26/mailcatcher/issues"
   end
 
   @@defaults = {
@@ -86,6 +70,7 @@ module MailCatcher extend self
     :http_ip => "127.0.0.1",
     :http_port => "1080",
     :http_path => "/",
+    :messages_limit => nil,
     :verbose => false,
     :daemon => !windows?,
     :browse => false,
@@ -105,6 +90,9 @@ module MailCatcher extend self
       OptionParser.new do |parser|
         parser.banner = "Usage: mailcatcher [options]"
         parser.version = VERSION
+        parser.separator ""
+        parser.separator "MailCatcher v#{VERSION}"
+        parser.separator ""
 
         parser.on("--ip IP", "Set the ip address of both servers") do |ip|
           options[:smtp_ip] = options[:http_ip] = ip
@@ -126,6 +114,10 @@ module MailCatcher extend self
           options[:http_port] = port
         end
 
+        parser.on("--messages-limit COUNT", Integer, "Only keep up to COUNT most recent messages") do |count|
+          options[:messages_limit] = count
+        end
+
         parser.on("--http-path PATH", String, "Add a prefix to all HTTP paths") do |path|
           clean_path = Rack::Utils.clean_path_info("/#{path}")
 
@@ -136,13 +128,6 @@ module MailCatcher extend self
           options[:quit] = false
         end
 
-        if mac?
-          parser.on("--[no-]growl") do |growl|
-            puts "Growl is no longer supported"
-            exit -2
-          end
-        end
-
         unless windows?
           parser.on("-f", "--foreground", "Run in the foreground") do
             options[:daemon] = false
@@ -159,10 +144,15 @@ module MailCatcher extend self
           options[:verbose] = true
         end
 
-        parser.on("-h", "--help", "Display this help information") do
+        parser.on_tail("-h", "--help", "Display this help information") do
           puts parser
           exit
         end
+
+        parser.on_tail("--version", "Display the current version") do
+          puts "MailCatcher v#{VERSION}"
+          exit
+        end
       end.parse!
     end
   end
@@ -181,7 +171,7 @@ module MailCatcher extend self
       $stdout.sync = $stderr.sync = true
     end
 
-    puts "Starting MailCatcher"
+    puts "Starting MailCatcher v#{VERSION}"
 
     Thin::Logging.debug = development?
     Thin::Logging.silent = !development?
@@ -223,6 +213,8 @@ module MailCatcher extend self
   end
 
   def quit!
+    MailCatcher::Bus.push(type: "quit")
+
     EventMachine.next_tick { EventMachine.stop_event_loop }
   end
 
@@ -233,7 +225,7 @@ protected
   end
 
   def http_url
-    "http://#{@@options[:http_ip]}:#{@@options[:http_port]}#{@@options[:http_path]}"
+    "http://#{@@options[:http_ip]}:#{@@options[:http_port]}#{@@options[:http_path]}".chomp("/")
   end
 
   def rescue_port port

data/lib/mail_catcher/bus.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "eventmachine"
+
+module MailCatcher
+  Bus = EventMachine::Channel.new
+end

data/lib/mail_catcher/mail.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "eventmachine"
 require "json"
 require "mail"
@@ -30,9 +32,11 @@ module MailCatcher::Mail extend self
             charset TEXT,
             body BLOB,
             size INTEGER,
-            created_at DATETIME DEFAULT CURRENT_DATETIME
+            created_at DATETIME DEFAULT CURRENT_DATETIME,
+            FOREIGN KEY (message_id) REFERENCES message (id) ON DELETE CASCADE
           )
         SQL
+        db.foreign_keys = true
       end
     end
   end
@@ -54,7 +58,7 @@ module MailCatcher::Mail extend self
 
     EventMachine.next_tick do
       message = MailCatcher::Mail.message message_id
-      MailCatcher::Events::MessageAdded.push message
+      MailCatcher::Bus.push(type: "add", message: message)
     end
   end
 
@@ -151,16 +155,29 @@ module MailCatcher::Mail extend self
 
   def delete!
     @delete_all_messages_query ||= db.prepare "DELETE FROM message"
-    @delete_all_message_parts_query ||= db.prepare "DELETE FROM message_part"
+    @delete_all_messages_query.execute
 
-    @delete_all_messages_query.execute and
-    @delete_all_message_parts_query.execute
+    EventMachine.next_tick do
+      MailCatcher::Bus.push(type: "clear")
+    end
   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.execute(message_id) and
-    @delete_message_parts_query.execute(message_id)
+    @delete_messages_query.execute(message_id)
+
+    EventMachine.next_tick do
+      MailCatcher::Bus.push(type: "remove", id: message_id)
+    end
+  end
+
+  def delete_older_messages!(count = MailCatcher.options[:messages_limit])
+    return if count.nil?
+    @older_messages_query ||= db.prepare "SELECT id FROM message WHERE id NOT IN (SELECT id FROM message ORDER BY created_at DESC LIMIT ?)"
+    @older_messages_query.execute(count).map do |row|
+      Hash[row.fields.zip(row)]
+    end.each do |message|
+      delete_message!(message["id"])
+    end
   end
 end

data/lib/mail_catcher/smtp.rb

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
+
 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
-  # per [RFC 2821](http://tools.ietf.org/html/rfc2821#section-4.1.1.2)
+  # per [RFC 2821](https://tools.ietf.org/html/rfc2821#section-4.1.1.2)
   def process_mail_from sender
     if @state.include? :mail_from
       @state -= [:mail_from, :rcpt, :data]
+
       receive_reset
     end
 
@@ -20,30 +23,40 @@ class MailCatcher::Smtp < EventMachine::Protocols::SmtpServer
 
   def receive_reset
     @current_message = nil
+
     true
   end
 
   def receive_sender(sender)
+    # EventMachine SMTP advertises size extensions [https://tools.ietf.org/html/rfc1870]
+    # so strip potential " SIZE=..." suffixes from senders
+    sender = $` if sender =~ / SIZE=\d+\z/
+
     current_message[:sender] = sender
+
     true
   end
 
   def receive_recipient(recipient)
     current_message[:recipients] ||= []
     current_message[:recipients] << recipient
+
     true
   end
 
   def receive_data_chunk(lines)
-    current_message[:source] ||= ""
+    current_message[:source] ||= +""
+
     lines.each do |line|
       current_message[:source] << line << "\r\n"
     end
+
     true
   end
 
   def receive_message
     MailCatcher::Mail.add_message current_message
+    MailCatcher::Mail.delete_older_messages!
     puts "==> SMTP: Received message from '#{current_message[:sender]}' (#{current_message[:source].length} bytes)"
     true
   rescue => exception

data/lib/mail_catcher/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MailCatcher
-  VERSION = "0.7.0"
+  VERSION = "0.8.0.beta4"
 end

data/lib/mail_catcher/web.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rack/builder"
 
 require "mail_catcher/web/application"

data/lib/mail_catcher/web/application.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pathname"
 require "net/http"
 require "uri"
@@ -5,7 +7,7 @@ require "uri"
 require "sinatra"
 require "skinny"
 
-require "mail_catcher/events"
+require "mail_catcher/bus"
 require "mail_catcher/mail"
 
 class Sinatra::Request
@@ -62,7 +64,7 @@ module MailCatcher
         if request.websocket?
           request.websocket!(
             :on_start => proc do |websocket|
-              subscription = Events::MessageAdded.subscribe do |message|
+              bus_subscription = MailCatcher::Bus.subscribe do |message|
                 begin
                   websocket.send_message(JSON.generate(message))
                 rescue => exception
@@ -71,7 +73,7 @@ module MailCatcher
               end
 
               websocket.on_close do |*|
-                Events::MessageAdded.unsubscribe subscription
+                MailCatcher::Bus.unsubscribe bus_subscription
               end
             end)
         else
@@ -95,9 +97,7 @@ module MailCatcher
               ("html" if Mail.message_has_html? id),
               ("plain" if Mail.message_has_plain? id)
             ].compact,
-            "attachments" => Mail.message_attachments(id).map do |attachment|
-              attachment.merge({"href" => "/messages/#{escape(id)}/parts/#{escape(attachment["cid"])}"})
-            end,
+            "attachments" => Mail.message_attachments(id),
           }))
         else
           not_found

data/lib/mailcatcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "mail_catcher"
 
 Mailcatcher = MailCatcher