letter_opener 1.0.0 → 1.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0ef387f446fe58d7fbe039333d493cc644dbb388323e098f2b4a0a48dfad93ac
+  data.tar.gz: 3d6da1bcc7fa1d575e00d361677e36a73dfd26ea331416cfbb31c14cdd8f87ac
+SHA512:
+  metadata.gz: 62fc742943f4904086cfdddcd0908c7bb67fd602530e340852eb213644bce32e664e6da00058767fd80cfc8f13735e757e2d4fa32cb4459be74df8bdf7348030
+  data.tar.gz: 827cb033ed7805de3399f2c32427e69190a15420314d2f4ad6b4f3856a8209d6cbf0b0d5701ea6e47dd996fd919ef5e9185389df3b151ce24b3ad67a693492a6

data/CHANGELOG.md

@@ -1,24 +1,82 @@
+## master ##
+ * Use default configuration in `Message::rendered_messages` (thanks [Krystan HuffMenne
+](https://github.com/gitKrystan))
+ * Do not use `Rails.root` path if LetterOpener is used outside of Rails (thanks [centrevillage](https://github.com/centrevillage))
+ * Allow to set only `Mail#cc`/`Mail#bcc` without `Mail#to`.
+
+## 1.6.0 ##
+ * Do not depend on Mail gem to check delivery params.
+ * Do not parse and escape url before passing it to Launchy.
+
+## 1.5.0 ##
+ * Use proper check for `Rails::Railties` (thanks [Florian Weingarten](https://github.com/fw42))
+ * Add a shim for the iFrame "srcdoc" attribute (make it work with IE).
+ * Do not convert `-` to `_` in attachment file names. (thanks [Steven Harman](https://github.com/stevenharman))
+ * Drop Ruby 1.9 support.
+ * Escape inline attachment names the same way they are stored in the attachments directory (thanks [Daniel Rikowski](https://github.com/daniel-rikowski))
+ * Increase timestamp precision in the mail filename. (thanks [Piotr Usewicz](https://github.com/pusewicz))
+ * Add ability to configure location of stored mails. (thanks [Ben](https://github.com/beejamin))
+ * Add light version of template for mails that doesn't render any additional styling. (thanks [Ben](https://github.com/beejamin))
+
+## 1.4.1 ##
+ * Stop base tag appearing in plain-text previews. (thanks [Coby Chapple](https://github.com/cobyism))
+
+## 1.4.0 ##
+ * Add base tag to the iframe so links work with X-Frame-Options set to SAMEORIGIN. (thanks [Jason Tokoph](https://github.com/jtokoph))
+ * Check delivery params before rendering an email to match SMTP behaviour.
+
+## 1.3.0 ##
+
+ * Fix message body encoding is observed correctly in QP CTE. (thanks [Mark Dodwell](https://github.com/mkdynamic))
+ * Remove fixed width on the mail content. (thanks [weexpectedTHIS](https://github.com/weexpectedTHIS))
+ * Render email content in the iframe. Fixes [#98](https://github.com/ryanb/letter_opener/issues/98). (thanks [Jacob Maine](https://github.com/mainej))
+
+## 1.2.0 ##
+
+  * Fix auto_link() which in some cases would return an empty <a> tag for plain text messages. (thanks [Kevin McPhillips](https://github.com/kmcphillips))
+  * Update styles. (thanks [Adam Doppelt](https://github.com/gurgeous))
+
+## 1.1.2 ##
+
+  * Show formatted display names in html template (thanks [ClaireMcGinty](https://github.com/ClaireMcGinty))
+  * Use `file:///` uri scheme to fix Launchy on Windows.
+
+## 1.1.1 ##
+
+  * Handle cc and bcc as array of emails. (thanks [jordandcarter](https://github.com/jordandcarter))
+  * Use `file://` uri scheme since Launcy can't open escaped URL without it. (thanks [Adrian2112](https://github.com/Adrian2112))
+  * Update Launchy dependency to `~> 2.2` (thanks [JeanMertz](https://github.com/JeanMertz))
+  * Change all nonword chars in filename of attachment to underscore so
+    it can be saved on all platforms. (thanks [phallstrom](https://github.com/phallstrom))
+
+## 1.1.0 ##
+
+  * Update Launchy dependency to `~> 2.2.0` (thanks [webdevotion](https://github.com/webdevotion))
+  * Handle `sender` field (thanks [sjtipton](https://github.com/sjtipton))
+  * Show subject only if it's present (thanks [jadehyper](https://github.com/jadehyper))
+  * Show subject as title of web page (thanks [statique](https://github.com/statique))
+
 ## 1.0.0 ##
 
-  * Attachment Support (thanks David Cornu)
+  * Attachment Support (thanks [David Cornu](https://github.com/davidcornu))
   * Escape HTML in subject and other fields
   * Raise an exception if the :location option is not present instead of using a default
-  * Open rich version by default (thanks Damir)
-  * Override margin on dt and dd elements in CSS (thanks Edgars Beigarts)
-  * Autolink URLs in plain version (thanks Matt Burke)
+  * Open rich version by default (thanks [Damir](https://github.com/sidonath))
+  * Override margin on dt and dd elements in CSS (thanks [Edgars Beigarts](https://github.com/ebeigarts))
+  * Autolink URLs in plain version (thanks [Matt Burke](https://github.com/spraints))
 
 ## 0.1.0 ##
 
   * From and To show name and Email when specified
   * Fix bug when letter_opener couldn't open email in Windows
-  * Handle spaces in the application path (thanks Mike Boone)
-  * As letter_opener doesn't work with Launchy < 2.0.4 let's depend on >= 2.0.4 (thanks Samnang Chhun)
-  * Handle `reply_to` field (thanks Wes Gibbs)
-  * Set the charset in email preview (thanks Bruno Michel)
+  * Handle spaces in the application path (thanks [Mike Boone](https://github.com/boone))
+  * As letter_opener doesn't work with Launchy < 2.0.4 let's depend on >= 2.0.4 (thanks [Samnang Chhun](https://github.com/samnang))
+  * Handle `reply_to` field (thanks [Wes Gibbs](https://github.com/wgibbs))
+  * Set the charset in email preview (thanks [Bruno Michel](https://github.com/nono))
 
 ## 0.0.2 ##
 
-  * Fixing launchy requirement (thanks Bruno Michel)
+  * Fixing launchy requirement (thanks [Bruno Michel](https://github.com/nono))
 
 ## 0.0.1 ##
 

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 gemspec
 
 gem "rake"

data/README.rdoc

@@ -1,6 +1,6 @@
 = Letter Opener {<img src="https://secure.travis-ci.org/ryanb/letter_opener.png" />}[http://travis-ci.org/ryanb/letter_opener]
 
-Preview email in the browser instead of sending it. This means you do not need to set up email delivery in your development environment, and you no longer need to worry about accidentally sending a test email to someone else's address.
+Preview email in the default browser instead of sending it. This means you do not need to set up email delivery in your development environment, and you no longer need to worry about accidentally sending a test email to someone else's address.
 
 
 == Rails Setup
@@ -12,9 +12,26 @@ First add the gem to your development environment and run the +bundle+ command t
 Then set the delivery method in <tt>config/environments/development.rb</tt>
 
   config.action_mailer.delivery_method = :letter_opener
+  config.action_mailer.perform_deliveries = true
 
 Now any email will pop up in your browser instead of being sent. The messages are stored in <tt>tmp/letter_opener</tt>.
+If you want to change application that will be used to open your emails you should override <tt>LAUNCHY_APPLICATION</tt> environment variable or set <tt>Launchy.application</tt> in the initializer.
 
+==== Configuration
+
+  LetterOpener.configure do |config|
+    # To overrider the location for message storage.
+    # Default value is <tt>tmp/letter_opener</tt>
+    config.location = Rails.root.join('tmp', 'my_mails')
+
+    # To render only the message body, without any metadata or extra containers or styling.
+    # Default value is <tt>:default</tt> that renders styled message with showing useful metadata.
+    config.message_template = :light
+  end
+
+==== For Rails 2.3.x support
+
+There is a fork that add support for Rails 2.3.x, in order to use that or just check it out you should go to https://github.com/cavi21/letter_opener
 
 == Non Rails Setup
 
@@ -25,6 +42,14 @@ If you aren't using Rails, this can be easily set up with the Mail gem. Just set
     delivery_method LetterOpener::DeliveryMethod, :location => File.expand_path('../tmp/letter_opener', __FILE__)
   end
 
+The method is similar if you're using the Pony gem:
+
+  require "letter_opener"
+  Pony.options = {
+    :via => LetterOpener::DeliveryMethod,
+    :via_options => {:location => File.expand_path('../tmp/letter_opener', __FILE__)}
+  }
+
 Alternatively, if you are using ActionMailer directly (without Rails) you will need to add the delivery method.
 
   require "letter_opener"
@@ -32,6 +57,13 @@ Alternatively, if you are using ActionMailer directly (without Rails) you will n
   ActionMailer::Base.delivery_method = :letter_opener
 
 
+== Remote Alternatives
+
+Letter Opener uses {Launchy}[https://github.com/copiousfreetime/launchy] to open sent mail in the browser. This assumes the Ruby process is running on the local development machine. If you are using a separate staging server or VM this will not work. In that case consider using {Mailtrap}[http://mailtrap.io/] or {MailCatcher}[http://mailcatcher.me/].
+
+In order to keep this project simple, I don't have plans to turn it into a Rails engine with an interface for browsing the sent mail but there is a {gem you can use for that}[https://github.com/fgrehm/letter_opener_web].
+
+
 == Development & Feedback
 
 Questions or problems? Please use the {issue tracker}[https://github.com/ryanb/letter_opener/issues]. If you would like to contribute to this project, fork this repository and run +bundle+ and +rake+ to run the tests. Pull requests appreciated.

data/lib/letter_opener/configuration.rb

@@ -0,0 +1,10 @@
+module LetterOpener
+  class Configuration
+    attr_accessor :location, :message_template
+
+    def initialize
+      @location = Rails.root.join('tmp', 'letter_opener') if defined?(Rails) && Rails.respond_to?(:root)
+      @message_template = 'default'
+    end
+  end
+end

data/lib/letter_opener/delivery_method.rb

@@ -1,3 +1,6 @@
+require "digest/sha1"
+require "launchy"
+
 module LetterOpener
   class DeliveryMethod
     class InvalidOption < StandardError; end
@@ -5,14 +8,32 @@ module LetterOpener
     attr_accessor :settings
 
     def initialize(options = {})
+      options[:message_template] ||= LetterOpener.configuration.message_template
+      options[:location] ||= LetterOpener.configuration.location
+
       raise InvalidOption, "A location option is required when using the Letter Opener delivery method" if options[:location].nil?
+
       self.settings = options
     end
 
     def deliver!(mail)
-      location = File.join(settings[:location], "#{Time.now.to_i}_#{Digest::SHA1.hexdigest(mail.encoded)[0..6]}")
-      messages = Message.rendered_messages(location, mail)
-      Launchy.open(URI.parse(URI.escape(messages.first.filepath)))
+      validate_mail!(mail)
+      location = File.join(settings[:location], "#{Time.now.to_f.to_s.tr('.', '_')}_#{Digest::SHA1.hexdigest(mail.encoded)[0..6]}")
+
+      messages = Message.rendered_messages(mail, location: location, message_template: settings[:message_template])
+      Launchy.open("file:///#{messages.first.filepath}")
+    end
+
+    private
+
+    def validate_mail!(mail)
+      if !mail.smtp_envelope_from || mail.smtp_envelope_from.empty?
+        raise ArgumentError, "SMTP From address may not be blank"
+      end
+
+      if !mail.smtp_envelope_to || mail.smtp_envelope_to.empty?
+        raise ArgumentError, "SMTP To address may not be blank"
+      end
     end
   end
 end

data/lib/letter_opener/message.rb

@@ -1,21 +1,32 @@
+require "cgi"
+require "erb"
+require "fileutils"
+require "uri"
+
 module LetterOpener
   class Message
     attr_reader :mail
 
-    def self.rendered_messages(location, mail)
+    def self.rendered_messages(mail, options = {})
       messages = []
-      messages << new(location, mail, mail.html_part) if mail.html_part
-      messages << new(location, mail, mail.text_part) if mail.text_part
-      messages << new(location, mail) if messages.empty?
+      messages << new(mail, options.merge(part: mail.html_part)) if mail.html_part
+      messages << new(mail, options.merge(part: mail.text_part)) if mail.text_part
+      messages << new(mail, options) if messages.empty?
       messages.each(&:render)
       messages.sort
     end
 
-    def initialize(location, mail, part = nil)
-      @location = location
+    ERROR_MSG = '%s or default configuration must be given'.freeze
+
+    def initialize(mail, options = {})
       @mail = mail
-      @part = part
+      @location = options[:location] || LetterOpener.configuration.location
+      @part = options[:part]
+      @template = options[:message_template] || LetterOpener.configuration.message_template
       @attachments = []
+
+      raise ArgumentError, ERROR_MSG % 'options[:location]' unless @location
+      raise ArgumentError, ERROR_MSG % 'options[:message_template]' unless @template
     end
 
     def render
@@ -25,13 +36,14 @@ module LetterOpener
         attachments_dir = File.join(@location, 'attachments')
         FileUtils.mkdir_p(attachments_dir)
         mail.attachments.each do |attachment|
-          path = File.join(attachments_dir, attachment.filename)
+          filename = attachment_filename(attachment)
+          path = File.join(attachments_dir, filename)
 
-          unless File.exists?(path) # true if other parts have already been rendered
+          unless File.exist?(path) # true if other parts have already been rendered
             File.open(path, 'wb') { |f| f.write(attachment.body.raw_source) }
           end
 
-          @attachments << [attachment.filename, "attachments/#{URI.escape(attachment.filename)}"]
+          @attachments << [attachment.filename, "attachments/#{CGI.escape(filename)}"]
         end
       end
 
@@ -41,7 +53,7 @@ module LetterOpener
     end
 
     def template
-      File.read(File.expand_path("../message.html.erb", __FILE__))
+      File.read(File.expand_path("../templates/#{@template}.html.erb", __FILE__))
     end
 
     def filepath
@@ -54,10 +66,10 @@ module LetterOpener
 
     def body
       @body ||= begin
-        body = (@part && @part.body || @mail.body).to_s
+        body = (@part || @mail).decoded
 
         mail.attachments.each do |attachment|
-          body.gsub!(attachment.url, "attachments/#{attachment.filename}")
+          body.gsub!(attachment.url, "attachments/#{attachment_filename(attachment)}")
         end
 
         body
@@ -65,15 +77,27 @@ module LetterOpener
     end
 
     def from
-      @from ||= Array(@mail.from).join(", ")
+      @from ||= Array(@mail['from']).join(", ")
+    end
+
+    def sender
+      @sender ||= Array(@mail['sender']).join(", ")
     end
 
     def to
-      @to ||= Array(@mail.to).join(", ")
+      @to ||= Array(@mail['to']).join(", ")
+    end
+
+    def cc
+      @cc ||= Array(@mail['cc']).join(", ")
+    end
+
+    def bcc
+      @bcc ||= Array(@mail['bcc']).join(", ")
     end
 
     def reply_to
-      @reply_to ||= Array(@mail.reply_to).join(", ")
+      @reply_to ||= Array(@mail['reply-to']).join(", ")
     end
 
     def type
@@ -85,8 +109,8 @@ module LetterOpener
     end
 
     def auto_link(text)
-      text.gsub(URI.regexp(%W[https http])) do
-        "<a href=\"#{$&}\">#{$&}</a>"
+      text.gsub(URI::Parser.new.make_regexp(%W[https http])) do |link|
+        "<a href=\"#{ link }\">#{ link }</a>"
       end
     end
 
@@ -94,6 +118,10 @@ module LetterOpener
       CGI.escapeHTML(content)
     end
 
+    def attachment_filename(attachment)
+      attachment.filename.gsub(/[^\w\-.]/, '_')
+    end
+
     def <=>(other)
       order = %w[rich plain]
       order.index(type) <=> order.index(other.type)

data/lib/letter_opener/railtie.rb

@@ -1,7 +1,12 @@
 module LetterOpener
   class Railtie < Rails::Railtie
     initializer "letter_opener.add_delivery_method" do
-      ActionMailer::Base.add_delivery_method :letter_opener, LetterOpener::DeliveryMethod, :location => Rails.root.join("tmp", "letter_opener")
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.add_delivery_method(
+          :letter_opener,
+          LetterOpener::DeliveryMethod
+        )
+      end
     end
   end
 end

data/lib/letter_opener/templates/default.html.erb

@@ -0,0 +1,138 @@
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=<%= encoding %>">
+    <% if mail.subject %>
+      <title><%= h mail.subject %></title>
+    <% end %>
+
+    <style type="text/css">
+      #container {
+        margin: 10px auto;
+      }
+      #message_headers {
+        background: #fff;
+        font-size: 12px;
+        font-family: "Segoe UI", "Helvetica Neue", Arial, sans-serif;
+        border-bottom: 1px solid #dedede;
+        margin-bottom: 10px;
+        overflow: auto;
+      }
+
+      #message_headers dl {
+        float: left;
+        line-height: 1.3em;
+        padding: 0;
+      }
+
+      #message_headers dt {
+        width: 92px;
+        margin: 0;
+        float: left;
+        text-align: right;
+        font-weight: bold;
+        color: #7f7f7f;
+      }
+
+      #message_headers dd {
+        margin: 0 0 0 102px;
+      }
+
+      #message_headers p.alternate {
+        float: right;
+        margin: 0;
+      }
+
+      #message_headers p.alternate a {
+        color: #09c;
+      }
+
+      pre#message_body {
+        padding: 4px;
+        white-space: pre-wrap;
+        border: 1px solid #eee;
+        background-color: #fcfcfc;
+      }
+
+      iframe {
+        border: 0;
+        width: 100%;
+        height: 100%;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="container">
+      <div id="message_headers">
+        <dl>
+          <dt>From:</dt>
+          <dd><%= h from %></dd>
+
+          <% unless sender.empty? %>
+            <dt>Sender:</dt>
+            <dd><%= h sender %></dd>
+          <% end %>
+
+          <% unless reply_to.empty? %>
+            <dt>Reply-To:</dt>
+            <dd><%= h reply_to %></dd>
+          <% end %>
+
+          <% if mail.subject %>
+            <dt>Subject:</dt>
+            <dd><strong><%= h mail.subject %></strong></dd>
+          <% end %>
+
+          <dt>Date:</dt>
+          <dd><%= Time.now.strftime("%b %e, %Y %I:%M:%S %p %Z") %></dd>
+
+          <% unless to.empty? %>
+            <dt>To:</dt>
+            <dd><%= h to %></dd>
+          <% end %>
+
+          <% unless cc.empty? %>
+            <dt>CC:</dt>
+            <dd><%= h cc %></dd>
+          <% end %>
+
+          <% unless bcc.empty? %>
+            <dt>BCC:</dt>
+            <dd><%= h bcc %></dd>
+          <% end %>
+
+          <% if @attachments.any? %>
+            <dt>Attachments:</dt>
+            <dd>
+            <% @attachments.each do |filename, path| %>
+              <a href="<%= path %>"><%= filename %></a>&nbsp;
+            <% end %>
+            </dd>
+          <% end %>
+        </dl>
+
+        <% if mail.multipart? %>
+          <p class="alternate">
+            <% if type == "plain" && mail.html_part %>
+              <a href="rich.html">View HTML version</a>
+            <% elsif type == "rich" && mail.text_part %>
+              <a href="plain.html">View plain text version</a>
+            <% end %>
+          </p>
+        <% end %>
+      </div>
+
+      <% if type == "plain" %>
+        <pre id="message_body"><%= auto_link(h(body)) %></pre>
+      <% else %>
+        <iframe seamless="seamless" srcdoc="<base target='_top'><%= h(body) %>"></iframe>
+      <% end %>
+    </div>
+
+    <script type="text/javascript">
+      /*! srcdoc-polyfill - v0.1.1 - 2013-03-01
+      * http://github.com/jugglinmike/srcdoc-polyfill/
+      * Copyright (c) 2013 Mike Pennisi; Licensed MIT */
+      (function(t,e){var c,n,o=t.srcDoc,r=!!("srcdoc"in e.createElement("iframe")),i={compliant:function(t,e){e&&t.setAttribute("srcdoc",e)},legacy:function(t,e){var c;t&&t.getAttribute&&(e?t.setAttribute("srcdoc",e):e=t.getAttribute("srcdoc"),e&&(c="javascript: window.frameElement.getAttribute('srcdoc');",t.setAttribute("src",c),t.contentWindow&&(t.contentWindow.location=c)))}},s=t.srcDoc={set:i.compliant,noConflict:function(){return t.srcDoc=o,s}};if(!r)for(s.set=i.legacy,n=e.getElementsByTagName("iframe"),c=n.length;c--;)s.set(n[c])})(this,this.document);
+    </script>
+  </body>
+</html>

data/lib/letter_opener/templates/light.html.erb

@@ -0,0 +1,11 @@
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=<%= encoding %>">
+    <% if mail.subject %>
+      <title><%= h mail.subject %></title>
+    <% end %>
+  </head>
+  <body>
+    <%= body %>
+  </body>
+</html>

data/lib/letter_opener.rb

@@ -1,9 +1,15 @@
-require "fileutils"
-require "digest/sha1"
-require "cgi"
-require "uri"
-require "launchy"
+module LetterOpener
+  autoload :Message, "letter_opener/message"
+  autoload :DeliveryMethod, "letter_opener/delivery_method"
+  autoload :Configuration, "letter_opener/configuration"
 
-require "letter_opener/message"
-require "letter_opener/delivery_method"
-require "letter_opener/railtie" if defined? Rails
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end
+
+require "letter_opener/railtie" if defined?(Rails::Railtie)