mailcatcher 0.5.12 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 087ab236a57889861232c36337622a2c491f015e
-  data.tar.gz: 2025e9693e21dae93e87d28261ae520ea3b1d4f8
+SHA256:
+  metadata.gz: 398459f93087b0066f8e2f8fd34781c2db1c6c3a8b2e13183a5cc425765f3347
+  data.tar.gz: 167623ed70957092aa6609d872cec9098f4d92184033df8b1cda9f83a2d8a31d
 SHA512:
-  metadata.gz: 96f670bb993dc0f567da90089a88effdec7ec1f4fcd30d85e7f0d63a9ee18446f4edd0b6ebbb48a3062d0f7bd0cfb9fe41cfd0edea05d53864cfc5930b034121
-  data.tar.gz: 42daf4cd55e174e109c08c041261ac3cd5597b57fdcb5a6e632a31e838f8a4b7f828a24871e18833aa5de6635848065d150ee93f7eaab3f9aef0df0ed6f19b31
+  metadata.gz: 65dcc3d2041456601dfd69f4cb522817522b7243cc1ac09b2e08c3905693cf99063aad8f262154577d2ad3ea94836c27cd0be7f1186cadf2abab7f968b7778e4
+  data.tar.gz: 71bbe2396c4ba43857d346a5ee93269e314ac2cf4f694babfaf7a79c96f4d6c9f86d1df76f66b76e4e8df272371963c94418f07ce5cc2a9d204a13a0f4b3ea7b

data/README.md

@@ -4,65 +4,119 @@ 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)
+![MailCatcher screenshot](https://cloud.githubusercontent.com/assets/14028/14093249/4100f904-f598-11e5-936b-e6a396f18e39.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].
+* 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.
-* 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.
+* 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
 
-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]
+
+MailCatcher v0.8.0
+
+        --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
+        --messages-limit COUNT       Only keep up to COUNT most recent messages
+        --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
+        --version                    Display the current version
+```
+
+### 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
 
-Please don't put mailcatcher into your Gemfile. It will conflict with your applications gems at some point.
+Please don't put mailcatcher into your Gemfile. It will conflict with your application's 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 `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 }
+    config.action_mailer.smtp_settings = { :address => '127.0.0.1', :port => 1025 }
+    config.action_mailer.raise_delivery_errors = false
 
 ### 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
+    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](https://www.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, 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`.
@@ -70,41 +124,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.
-* 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?
+* 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
-  [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
+  [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'
@@ -13,7 +14,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 +34,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 +57,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,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'mail_catcher'
+
 MailCatcher.run!

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,12 +1,14 @@
-require 'active_support/json'
-require 'mail'
-require 'sqlite3'
-require 'eventmachine'
+# frozen_string_literal: true
+
+require "eventmachine"
+require "json"
+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,
@@ -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.execute("PRAGMA foreign_keys = ON")
       end
     end
   end
@@ -41,7 +45,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], JSON.generate(message[:recipients]), 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,12 +53,12 @@ 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
       message = MailCatcher::Mail.message message_id
-      MailCatcher::Events::MessageAdded.push message
+      MailCatcher::Bus.push(type: "add", message: message)
     end
   end
 
@@ -69,25 +73,31 @@ 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"]
+        message["recipients"] &&= JSON.parse(message["recipients"])
       end
     end
   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"] &&= ActiveSupport::JSON.decode message["recipients"]
+      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"])
+    (!!@message_has_html_query.execute(id).next) || ["text/html", "application/xhtml+xml"].include?(message(id)["type"])
   end
 
   def message_has_plain?(id)
@@ -126,7 +136,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 and ["text/html", "application/xhtml+xml"].include? message["type"]
     end
   end
 
@@ -135,7 +145,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,17 +154,30 @@ 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_all_messages_query ||= db.prepare "DELETE FROM message"
+    @delete_all_messages_query.execute
 
-    @delete_messages_query.execute and
-    @delete_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 ||= db.prepare "DELETE FROM message WHERE 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,11 +1,16 @@
-require 'eventmachine'
+# 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
 
@@ -18,38 +23,44 @@ 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.join("\n")
+    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
-    puts "*** Error receiving message: #{current_message.inspect}"
-    puts "    Exception: #{$!}"
-    puts "    Backtrace:"
-    $!.backtrace.each do |line|
-      puts "       #{line}"
-    end
-    puts "    Please submit this as an issue at http://github.com/sj26/mailcatcher/issues"
+  rescue => exception
+    MailCatcher.log_exception("Error receiving message", @current_message, exception)
     false
   ensure
     @current_message = nil

data/lib/mail_catcher/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MailCatcher
-  VERSION = "0.5.12"
+  VERSION = "0.8.1"
 end