mailcatcher_v0.7.1 0.7.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a853ef962eff875bdb2eea87b896b59cf3c5bbef40d228dffaef761fc3052f81
+  data.tar.gz: 03d6ad8b7a904558a16dab0ad16ca7baae8694f1dfcf039a9acf6ddefefdc7f5
+SHA512:
+  metadata.gz: e2ac1fed8b8b484b3cf8d44bb1deb133b937457eaf89d7e79ba509e5fb244ffa75cd706b91876c4d2b3f49a120e8adeba7aee04b87337554e18988e60ecbc72b
+  data.tar.gz: ac5479825d079974d3e4fcd62a88d765191cab0b2b934a38aef60385d9a0b25f0187406cb19caa0403e7f79ec0f532c57be6eb21ab99a808d5f0352cab40bbd7

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,112 @@
+# MailCatcher
+
+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](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 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 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://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].
+
+### 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, 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 with a wrapper script:
+
+    rvm default@mailcatcher --create do gem install mailcatcher
+    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 => '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:
+
+    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:
+
+    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`.
+
+## 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.
+* 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.
+
+## 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?
+
+## 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.
+
+## 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-2018 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/

data/bin/catchmail

@@ -0,0 +1,71 @@
+#!/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] [recipient ...]
+    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($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

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

data/lib/mail_catcher/events.rb

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

data/lib/mail_catcher/mail.rb

@@ -0,0 +1,166 @@
+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|
+        db.execute(<<-SQL)
+          CREATE TABLE message (
+            id INTEGER PRIMARY KEY ASC,
+            sender TEXT,
+            recipients TEXT,
+            subject TEXT,
+            source BLOB,
+            size TEXT,
+            type TEXT,
+            created_at DATETIME DEFAULT CURRENT_DATETIME
+          )
+        SQL
+        db.execute(<<-SQL)
+          CREATE TABLE message_part (
+            id INTEGER PRIMARY KEY ASC,
+            message_id INTEGER NOT NULL,
+            cid TEXT,
+            type TEXT,
+            is_attachment INTEGER,
+            filename TEXT,
+            charset TEXT,
+            body BLOB,
+            size INTEGER,
+            created_at DATETIME DEFAULT CURRENT_DATETIME
+          )
+        SQL
+      end
+    end
+  end
+
+  def add_message(message)
+    @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], 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?
+    parts.each do |part|
+      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)
+    end
+
+    EventMachine.next_tick do
+      message = MailCatcher::Mail.message message_id
+      MailCatcher::Events::MessageAdded.push message
+    end
+  end
+
+  def add_message_part(*args)
+    @add_message_part_query ||= db.prepare "INSERT INTO message_part (message_id, cid, type, is_attachment, filename, charset, body, size, created_at) VALUES (?, ?, ?, ?, ?, ?, ?, ?, datetime('now'))"
+    @add_message_part_query.execute(*args)
+  end
+
+  def latest_created_at
+    @latest_created_at_query ||= db.prepare "SELECT created_at FROM message ORDER BY created_at DESC LIMIT 1"
+    @latest_created_at_query.execute.next
+  end
+
+  def messages
+    @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"] &&= JSON.parse(message["recipients"])
+      end
+    end
+  end
+
+  def message(id)
+    @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"])
+  end
+
+  def message_has_plain?(id)
+    @message_has_plain_query ||= db.prepare "SELECT 1 FROM message_part WHERE message_id = ? AND is_attachment = 0 AND type = 'text/plain' LIMIT 1"
+    (!!@message_has_plain_query.execute(id).next) || message(id)["type"] == "text/plain"
+  end
+
+  def message_parts(id)
+    @message_parts_query ||= db.prepare "SELECT cid, type, filename, size FROM message_part WHERE message_id = ? ORDER BY filename ASC"
+    @message_parts_query.execute(id).map do |row|
+      Hash[row.fields.zip(row)]
+    end
+  end
+
+  def message_attachments(id)
+    @message_parts_query ||= db.prepare "SELECT cid, type, filename, size FROM message_part WHERE message_id = ? AND is_attachment = 1 ORDER BY filename ASC"
+    @message_parts_query.execute(id).map do |row|
+      Hash[row.fields.zip(row)]
+    end
+  end
+
+  def message_part(message_id, part_id)
+    @message_part_query ||= db.prepare "SELECT * FROM message_part WHERE message_id = ? AND id = ? LIMIT 1"
+    row = @message_part_query.execute(message_id, part_id).next
+    row && Hash[row.fields.zip(row)]
+  end
+
+  def message_part_type(message_id, part_type)
+    @message_part_type_query ||= db.prepare "SELECT * FROM message_part WHERE message_id = ? AND type = ? AND is_attachment = 0 LIMIT 1"
+    row = @message_part_type_query.execute(message_id, part_type).next
+    row && Hash[row.fields.zip(row)]
+  end
+
+  def message_part_html(message_id)
+    part = message_part_type(message_id, "text/html")
+    part ||= message_part_type(message_id, "application/xhtml+xml")
+    part ||= begin
+      message = message(message_id)
+      message if message and ["text/html", "application/xhtml+xml"].include? message["type"]
+    end
+  end
+
+  def message_part_plain(message_id)
+    message_part_type message_id, "text/plain"
+  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.execute(message_id).map do |row|
+      Hash[row.fields.zip(row)]
+    end.find do |part|
+      part["cid"] == cid
+    end
+  end
+
+  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 and
+    @delete_all_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.execute(message_id) and
+    @delete_message_parts_query.execute(message_id)
+  end
+end

data/lib/mail_catcher/smtp.rb

@@ -0,0 +1,55 @@
+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)
+  def process_mail_from sender
+    if @state.include? :mail_from
+      @state -= [:mail_from, :rcpt, :data]
+      receive_reset
+    end
+
+    super
+  end
+
+  def current_message
+    @current_message ||= {}
+  end
+
+  def receive_reset
+    @current_message = nil
+    true
+  end
+
+  def receive_sender(sender)
+    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] ||= ""
+    lines.each do |line|
+      current_message[:source] << line << "\r\n"
+    end
+    true
+  end
+
+  def receive_message
+    MailCatcher::Mail.add_message current_message
+    puts "==> SMTP: Received message from '#{current_message[:sender]}' (#{current_message[:source].length} bytes)"
+    true
+  rescue => exception
+    MailCatcher.log_exception("Error receiving message", @current_message, exception)
+    false
+  ensure
+    @current_message = nil
+  end
+end

data/lib/mail_catcher/version.rb

@@ -0,0 +1,3 @@
+module MailCatcher
+  VERSION = "0.7.1"
+end

data/lib/mail_catcher/web/application.rb

@@ -0,0 +1,180 @@
+require "pathname"
+require "net/http"
+require "uri"
+
+require "sinatra"
+require "skinny"
+
+require "mail_catcher/events"
+require "mail_catcher/mail"
+
+class Sinatra::Request
+  include Skinny::Helpers
+end
+
+module MailCatcher
+  module Web
+    class Application < Sinatra::Base
+      set :environment, MailCatcher.env
+      set :prefix, MailCatcher.options[:http_path]
+      set :asset_prefix, File.join(prefix, "assets")
+      set :root, File.expand_path("#{__FILE__}/../../../..")
+
+      if development?
+        require "sprockets-helpers"
+
+        configure do
+          require "mail_catcher/web/assets"
+          Sprockets::Helpers.configure do |config|
+            config.environment = Assets
+            config.prefix      = settings.asset_prefix
+            config.digest      = false
+            config.public_path = public_folder
+            config.debug       = true
+          end
+        end
+
+        helpers do
+          include Sprockets::Helpers
+        end
+      else
+        helpers do
+          def asset_path(filename)
+            File.join(settings.asset_prefix, filename)
+          end
+        end
+      end
+
+      get "/" do
+        erb :index
+      end
+
+      delete "/" do
+        if MailCatcher.quittable?
+          MailCatcher.quit!
+          status 204
+        else
+          status 403
+        end
+      end
+
+      get "/messages" do
+        if request.websocket?
+          request.websocket!(
+            :on_start => proc do |websocket|
+              subscription = Events::MessageAdded.subscribe do |message|
+                begin
+                  websocket.send_message(JSON.generate(message))
+                rescue => exception
+                  MailCatcher.log_exception("Error sending message through websocket", message, exception)
+                end
+              end
+
+              websocket.on_close do |*|
+                Events::MessageAdded.unsubscribe subscription
+              end
+            end)
+        else
+          content_type :json
+          JSON.generate(Mail.messages)
+        end
+      end
+
+      delete "/messages" do
+        Mail.delete!
+        status 204
+      end
+
+      get "/messages/:id.json" do
+        id = params[:id].to_i
+        if message = Mail.message(id)
+          content_type :json
+          JSON.generate(message.merge({
+            "formats" => [
+              "source",
+              ("html" if Mail.message_has_html? id),
+              ("plain" if Mail.message_has_plain? id)
+            ].compact,
+            "attachments" => Mail.message_attachments(id).map do |attachment|
+              path_name = MailCatcher.options[:http_path] == "/" ? "" : MailCatcher.options[:http_path]
+              attachment.merge({"href" => "#{path_name}/messages/#{escape(id)}/parts/#{escape(attachment["cid"])}"})
+            end,
+          }))
+        else
+          not_found
+        end
+      end
+
+      get "/messages/:id.html" do
+        id = params[:id].to_i
+        if part = Mail.message_part_html(id)
+          content_type :html, :charset => (part["charset"] || "utf8")
+
+          body = part["body"]
+
+          # Rewrite body to link to embedded attachments served by cid
+          body.gsub! /cid:([^'"> ]+)/, "#{id}/parts/\\1"
+
+          body
+        else
+          not_found
+        end
+      end
+
+      get "/messages/:id.plain" do
+        id = params[:id].to_i
+        if part = Mail.message_part_plain(id)
+          content_type part["type"], :charset => (part["charset"] || "utf8")
+          part["body"]
+        else
+          not_found
+        end
+      end
+
+      get "/messages/:id.source" do
+        id = params[:id].to_i
+        if message_source = Mail.message_source(id)
+          content_type "text/plain"
+          message_source
+        else
+          not_found
+        end
+      end
+
+      get "/messages/:id.eml" do
+        id = params[:id].to_i
+        if message_source = Mail.message_source(id)
+          content_type "message/rfc822"
+          message_source
+        else
+          not_found
+        end
+      end
+
+      get "/messages/:id/parts/:cid" do
+        id = params[:id].to_i
+        if part = Mail.message_part_cid(id, params[:cid])
+          content_type part["type"], :charset => (part["charset"] || "utf8")
+          attachment part["filename"] if part["is_attachment"] == 1
+          body part["body"].to_s
+        else
+          not_found
+        end
+      end
+
+      delete "/messages/:id" do
+        id = params[:id].to_i
+        if Mail.message(id)
+          Mail.delete_message!(id)
+          status 204
+        else
+          not_found
+        end
+      end
+
+      not_found do
+        erb :"404"
+      end
+    end
+  end
+end

data/lib/mail_catcher/web.rb

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

data/lib/mail_catcher.rb

@@ -0,0 +1,255 @@
+# 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"
+
+require "open3"
+require "optparse"
+require "rbconfig"
+
+require "eventmachine"
+require "thin"
+
+module EventMachine
+  # Monkey patch fix for 10deb4
+  # See https://github.com/eventmachine/eventmachine/issues/569
+  def self.reactor_running?
+    (@reactor_running || false)
+  end
+end
+
+require "mail_catcher/version"
+
+module MailCatcher extend self
+  autoload :Events, "mail_catcher/events"
+  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))
+    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
+
+  def browse url
+    if windows?
+      system "start", "/b", url
+    elsif which? "open"
+      system "open", url
+    end
+  end
+
+  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_replace = '\1 (\2) \3'
+
+    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"
+  end
+
+  @@defaults = {
+    :smtp_ip => "127.0.0.1",
+    :smtp_port => "1025",
+    :http_ip => "127.0.0.1",
+    :http_port => "1080",
+    :http_path => "/",
+    :verbose => false,
+    :daemon => !windows?,
+    :browse => false,
+    :quit => true,
+  }
+
+  def options
+    @@options
+  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("--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
+
+        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
+          end
+        end
+
+        if browseable?
+          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 &&= @@defaults.merge options
+    # 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.debug = development?
+    Thin::Logging.silent = !development?
+
+    # One EventMachine loop...
+    EventMachine.run do
+      # 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 smtp_url
+    "smtp://#{@@options[:smtp_ip]}:#{@@options[:smtp_port]}"
+  end
+
+  def http_url
+    "http://#{@@options[:http_ip]}:#{@@options[:http_port]}#{@@options[:http_path]}"
+  end
+
+  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?"
+        puts "==> #{smtp_url}"
+        puts "==> #{http_url}"
+        exit -1
+      else
+        raise
+      end
+    end
+  end
+end

data/lib/mailcatcher.rb

@@ -0,0 +1,3 @@
+require "mail_catcher"
+
+Mailcatcher = MailCatcher

data/views/404.erb

@@ -0,0 +1,6 @@
+<html>
+<body>
+  <h1>No Dice</h1>
+  <p>The message you were looking for does not exist, or doesn't have content of this type.</p>
+</body>
+</html>

data/views/index.erb

@@ -0,0 +1,63 @@
+<!DOCTYPE html>
+<html class="mailcatcher">
+<head>
+  <title>MailCatcher</title>
+  <base href="<%= settings.prefix.chomp("/") %>/">
+  <link href="favicon.ico" rel="icon">
+  <script src="<%= asset_path("mailcatcher.js") %>"></script>
+  <link rel="stylesheet" href="<%= asset_path("mailcatcher.css") %>">
+</head>
+<body>
+  <header>
+    <h1><a href="http://mailcatcher.me" target="_blank">MailCatcher</a></h1>
+    <nav class="app">
+      <ul>
+        <li class="search"><input type="search" name="search" placeholder="Search messages..." incremental="true" /></li>
+        <li class="clear"><a href="#" title="Clear all messages">Clear</a></li>
+        <% if MailCatcher.quittable? %>
+          <li class="quit"><a href="#" title="Quit MailCatcher">Quit</a></li>
+        <% end %>
+      </ul>
+    </nav>
+  </header>
+  <nav id="messages">
+    <table>
+      <thead>
+        <tr>
+          <th>From</th>
+          <th>To</th>
+          <th>Subject</th>
+          <th>Received</th>
+        </tr>
+      </thead>
+      <tbody></tbody>
+    </table>
+  </nav>
+  <div id="resizer"><div class="ruler"></div></div>
+  <article id="message">
+    <header>
+      <dl class="metadata">
+        <dt class="created_at">Received</dt>
+        <dd class="created_at"></dd>
+        <dt class="from">From</dt>
+        <dd class="from"></dd>
+        <dt class="to">To</dt>
+        <dd class="to"></dd>
+        <dt class="subject">Subject</dt>
+        <dd class="subject"></dd>
+        <dt class="attachments">Attachments</dt>
+        <dd class="attachments"></dd>
+      </dl>
+      <nav class="views">
+        <ul>
+          <li class="format tab html selected" data-message-format="html"><a href="#">HTML</a></li>
+          <li class="format tab plain" data-message-format="plain"><a href="#">Plain Text</a></li>
+          <li class="format tab source" data-message-format="source"><a href="#">Source</a></li>
+          <li class="action download" data-message-format="html"><a href="#" class="button"><span>Download</span></a></li>
+        </ul>
+      </nav>
+    </header>
+    <iframe class="body"></iframe>
+  </article>
+</body>
+</html>

metadata

@@ -0,0 +1,332 @@
+--- !ruby/object:Gem::Specification
+name: mailcatcher_v0.7.1
+version: !ruby/object:Gem::Version
+  version: 0.7.1
+platform: ruby
+authors:
+- Samuel Cochran
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.9.1
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.9
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: skinny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: coffee-script
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: compass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uglifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+description: |2
+      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.
+email: sj26@sj26.com
+executables:
+- mailcatcher
+- catchmail
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- bin/catchmail
+- bin/mailcatcher
+- lib/mail_catcher.rb
+- lib/mail_catcher/events.rb
+- lib/mail_catcher/mail.rb
+- lib/mail_catcher/smtp.rb
+- lib/mail_catcher/version.rb
+- lib/mail_catcher/web.rb
+- lib/mail_catcher/web/application.rb
+- lib/mailcatcher.rb
+- public/favicon.ico
+- views/404.erb
+- views/index.erb
+homepage: http://mailcatcher.me
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Runs an SMTP server, catches and displays email in a web interface.
+test_files: []