mailcatcher 0.6.5 → 0.8.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: db48fc085519aaa785c4b09bd3fa312d25ab6e6f
-  data.tar.gz: 639ee7311ee33602a6e2ab8d5552e662dfe48199
+SHA256:
+  metadata.gz: 1fbbb01ee21a1d0946b2a6ba1e52b999567a8894b8f6b8816f4d796d924b4967
+  data.tar.gz: 6d6cc1c27dd58ce096fe1458075ce2ae04a30a22abba3629cc1ddbc9c7f3a7f4
 SHA512:
-  metadata.gz: 1b5c917befe705b2937ca462b1eef9d8b8e11f5d8c6a725e0192925ca2d2b2d52ebfe168e5560421af091ba4aeca5884e117b977a893219780c8eecddcbe25b2
-  data.tar.gz: 14fe6761586cc46b741f4bc4c8b893caf35767afeb67a1f99a3b62e86c94c162127b536f482860c992d690af15d8ba5e367e5dfdfdd0f6086ab7000c36632eff
+  metadata.gz: dcd37866fb64d92ebceaecb15747d68db22eed327417d6025db91c88b6ab5bdeaeff96b9596e2d011610a61da74deb8bbdd363a35a9da8dd75e2f1e7469b411f
+  data.tar.gz: 2057962471f539be4e496243285efabe3c31f9b24eca7c560e9645f32401839f481c5da116f9df6e7a407cd6e1e0cacefd7c03f14a00a8e798cdc23f8c7e0b86

data/README.md

@@ -10,44 +10,61 @@ 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.
+* Rewrites HTML enabling display of embedded, inline images/etc and opens 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.
-* 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.
+* Runs as a daemon in the background, optionally in foreground.
+* Sendmail-analogue command, `catchmail`, makes using mailcatcher from PHP a lot easier.
 * Keyboard navigation between messages
 
 ## How
 
 1. `gem install mailcatcher`
 2. `mailcatcher`
-3. Go to http://localhost:1080/
-4. Send mail through smtp://localhost:1025
+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].
 
+### Ruby
+
+If you have trouble with the above 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
 
 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.
+Instead, pop a note in your README stating you use mailcatcher, and to 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:
+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 with a wrapper script:
 
     rvm default@mailcatcher --create do gem install mailcatcher
-    rvm wrapper default@mailcatcher --no-prefix mailcatcher catchmail
+    ln -s "$(rvm default@mailcatcher do rvm wrapper show mailcatcher)" "$rvm_bin_path/"
 
 ### Rails
 
 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 }
+    config.action_mailer.smtp_settings = { :address => '127.0.0.1', :port => 1025 }
+    config.action_mailer.raise_delivery_errors = false
 
 ### PHP
 
@@ -67,7 +84,7 @@ If starting `mailcatcher` on alternative SMTP IP and/or port with parameters lik
 
 ### Django
 
-For use in Django, simply add the following configuration to your projects' settings.py
+For use in Django, add the following configuration to your projects' settings.py
 
 ```python
 if DEBUG:
@@ -85,36 +102,22 @@ 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
 
 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.
+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
-  [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

@@ -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,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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"
@@ -23,13 +25,22 @@ module EventMachine
   end
 end
 
-require "mail_catcher/events"
-require "mail_catcher/mail"
-require "mail_catcher/smtp"
-require "mail_catcher/web"
 require "mail_catcher/version"
 
 module MailCatcher extend self
+  autoload :Bus, "mail_catcher/bus"
+  autoload :Mail, "mail_catcher/mail"
+  autoload :Smtp, "mail_catcher/smtp"
+  autoload :Web, "mail_catcher/web"
+
+  def env
+    ENV.fetch("MAILCATCHER_ENV", "production")
+  end
+
+  def development?
+    env == "development"
+  end
+
   def which?(command)
     ENV["PATH"].split(File::PATH_SEPARATOR).any? do |directory|
       File.executable?(File.join(directory, command.to_s))
@@ -37,11 +48,11 @@ module MailCatcher extend self
   end
 
   def mac?
-    RbConfig::CONFIG['host_os'] =~ /darwin/
+    RbConfig::CONFIG["host_os"] =~ /darwin/
   end
 
   def windows?
-    RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+    RbConfig::CONFIG["host_os"] =~ /mswin|mingw/
   end
 
   def macruby?
@@ -62,7 +73,7 @@ module MailCatcher extend self
 
   def log_exception(message, context, exception)
     gems_paths = (Gem.path | [Gem.default_dir]).map { |path| Regexp.escape(path) }
-    gems_regexp = %r{(?:#{gems_paths.join('|')})/gems/([^/]+)-([\w.]+)/(.*)}
+    gems_regexp = %r{(?:#{gems_paths.join("|")})/gems/([^/]+)-([\w.]+)/(.*)}
     gems_replace = '\1 (\2) \3'
 
     puts "*** #{message}: #{context.inspect}"
@@ -72,10 +83,12 @@ module MailCatcher extend self
   end
 
   @@defaults = {
-    :smtp_ip => '127.0.0.1',
-    :smtp_port => '1025',
-    :http_ip => '127.0.0.1',
-    :http_port => '1080',
+    :smtp_ip => "127.0.0.1",
+    :smtp_port => "1025",
+    :http_ip => "127.0.0.1",
+    :http_port => "1080",
+    :http_path => "/",
+    :messages_limit => nil,
     :verbose => false,
     :daemon => !windows?,
     :browse => false,
@@ -95,6 +108,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
@@ -116,6 +132,16 @@ 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}")
+
+          options[:http_path] = clean_path
+        end
+
         parser.on("--no-quit", "Don't allow quitting the process") do
           options[:quit] = false
         end
@@ -128,32 +154,37 @@ module MailCatcher extend self
         end
 
         unless windows?
-          parser.on('-f', '--foreground', 'Run in the foreground') do
+          parser.on("-f", "--foreground", "Run in the foreground") do
             options[:daemon] = false
           end
         end
 
         if browseable?
-          parser.on('-b', '--browse', 'Open web browser') do
+          parser.on("-b", "--browse", "Open web browser") do
             options[:browse] = true
           end
         end
 
-        parser.on('-v', '--verbose', 'Be more verbose') do
+        parser.on("-v", "--verbose", "Be more verbose") do
           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 #{VERSION}"
+          exit
+        end
       end.parse!
     end
   end
 
   def run! options=nil
     # If we are passed options, fill in the blanks
-    options &&= options.reverse_merge @@defaults
+    options &&= @@defaults.merge options
     # Otherwise, parse them from ARGV
     options ||= parse!
 
@@ -167,7 +198,8 @@ module MailCatcher extend self
 
     puts "Starting MailCatcher"
 
-    Thin::Logging.silent = (ENV["MAILCATCHER_ENV"] != "development")
+    Thin::Logging.debug = development?
+    Thin::Logging.silent = !development?
 
     # One EventMachine loop...
     EventMachine.run do
@@ -216,7 +248,7 @@ protected
   end
 
   def http_url
-    "http://#{@@options[:http_ip]}:#{@@options[:http_port]}"
+    "http://#{@@options[:http_ip]}:#{@@options[:http_port]}#{@@options[:http_path]}"
   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
 
@@ -78,13 +82,19 @@ module MailCatcher::Mail extend self
   end
 
   def message(id)
-    @message_query ||= db.prepare "SELECT * FROM message WHERE id = ? LIMIT 1"
+    @message_query ||= db.prepare "SELECT id, sender, recipients, subject, size, type, created_at FROM message WHERE id = ? LIMIT 1"
     row = @message_query.execute(id).next
     row && Hash[row.fields.zip(row)].tap do |message|
       message["recipients"] &&= JSON.parse(message["recipients"])
     end
   end
 
+  def message_source(id)
+    @message_source_query ||= db.prepare "SELECT source FROM message WHERE id = ? LIMIT 1"
+    row = @message_source_query.execute(id).next
+    row && row.first
+  end
+
   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"])
@@ -145,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,3 +1,5 @@
+# frozen_string_literal: true
+
 require "eventmachine"
 
 require "mail_catcher/mail"
@@ -35,7 +37,7 @@ class MailCatcher::Smtp < EventMachine::Protocols::SmtpServer
   end
 
   def receive_data_chunk(lines)
-    current_message[:source] ||= ""
+    current_message[:source] ||= +""
     lines.each do |line|
       current_message[:source] << line << "\r\n"
     end
@@ -44,6 +46,7 @@ class MailCatcher::Smtp < EventMachine::Protocols::SmtpServer
 
   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.6.5"
+  VERSION = "0.8.0.beta3"
 end

data/lib/mail_catcher/web.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rack/builder"
 
 require "mail_catcher/web/application"
@@ -6,12 +8,17 @@ module MailCatcher
   module Web extend self
     def app
       @@app ||= Rack::Builder.new do
-        if ENV["MAILCATCHER_ENV"] == "development"
-          require "mail_catcher/web/assets"
-          map("/assets") { run Assets }
+        map(MailCatcher.options[:http_path]) do
+          if MailCatcher.development?
+            require "mail_catcher/web/assets"
+            map("/assets") { run Assets }
+          end
+
+          run Application
         end
 
-        map("/") { run Application }
+        # This should only affect when http_path is anything but "/" above
+        run lambda { |env| [302, {"Location" => MailCatcher.options[:http_path]}, []] }
       end
     end