JasonKing-InlineAttachment 0.3.3

data/README

@@ -0,0 +1,79 @@
+= Inline Attachment
+
+This package adds full support for embedding inline images into your HTML emails
+through ActionMailer.
+
+It is created from a Rails patch #2179 (found at http://dev.rubyonrails.org/ticket/2179).
+
+The goal of this gem is to remove the need for manual patching.
+
+== Installation
+
+To perform a system wide installation:
+
+<tt>gem install inline_attachment</tt>
+
+To use inline_attachment in your project, add the following line to your project's
+config/environment.rb:
+
+<tt>require 'inline_attachment'</tt>
+
+
+== Usage
+
+==== Embed Images Manually
+
+The code to add inline attachments into your HTML emails is pretty simple:
+
+	@cid = Time.now.to_f.to_s + "foobar.png@domain.com"
+ 
+	inline_attachment :content_type => "image/png", 
+	                  :body => File.read("#{RAILS_ROOT}/public/images/foobar.png"),
+	                  :filename => "foobar.png",
+	                  :cid => "<#{@cid}>"
+	
+Note that the above code should go into your ActionMailer.
+
+The instance variable @cid is the unique identifier your MIME email will be using to
+locate the attached image. All you have to do is then pass it over to your email
+template, and display it like so:
+
+	<img src="cid:<%= @cid %>" alt="Foo Bar" />
+	
+==== Embed Images Automatically
+
+As of version 0.2.0, Inline Attachment automatically embeds any images found within
+your ActionMailer templates. There is no longer any extra code required when adding images
+into your mail templates. Though, you must use rails image_tag helper when displaying
+images within your mailer views.
+
+With version 0.3.0, you are now able to embed images into nested parts by specifying 
+a part container to place the attached images into. For example:
+
+	class Notifier < ActionMailer::Base
+	  def images
+	    recipients   "test@test.com"
+	    from         "test@test.com"
+	    subject      "Test"
+	    content_type "multipart/alternative"
+    
+	    part "text/plain" do |p|
+	      p.body = render_message("images.text.plain.rhtml", {})
+	      p.content_disposition = ""
+	      p.transfer_encoding = "7bit"
+	      p.charset = "ISO-8859-15"
+	    end
+    
+	    part "multipart/related" do |p|
+	      p.parts << ActionMailer::Part.new(
+	        :content_type => "text/html", :body => render_message("images.text.html.rhtml", :part_container => p),
+	        :disposition => "",
+	        :charset => "ISO-8859-15",
+	        :transfer_encoding => "7bit"
+	      )
+	    end
+	  end
+	end
+	
+You can see that we passed in the variable :part_container => p into the body of the nested part.
+This needs to be done so that the images are embedded into the part that they are used in.

data/lib/inline_attachment.rb

@@ -0,0 +1,117 @@
+module ActionMailer
+  module PartContainer
+    # Add an inline attachment to a multipart message. 
+    def inline_attachment(params, &block)
+      params = { :content_type => params } if String === params
+      params = { :disposition => "inline",
+                 :transfer_encoding => "base64" }.merge(params)
+      params[:headers] ||= {}
+      params[:headers]['Content-ID'] = params[:cid]
+      part(params, &block)
+    end
+  end
+
+  class Part
+    def to_mail(defaults)
+      part = TMail::Mail.new
+
+      if @parts.empty?
+        part.content_transfer_encoding = transfer_encoding || "quoted-printable"
+        case (transfer_encoding || "").downcase
+          when "base64" then
+            part.body = TMail::Base64.folding_encode(body)
+          when "quoted-printable"
+            part.body = [Utils.normalize_new_lines(body)].pack("M*")
+          else
+            part.body = body
+        end
+
+        # Always set the content_type after setting the body and or parts
+
+        # CHANGE: treat attachments and inline files the same
+        if content_disposition == "attachment" || ((content_disposition == "inline") && filename)
+            part.set_content_type(content_type || defaults.content_type, nil,
+            squish("charset" => nil, "name" => filename))
+        else
+          part.set_content_type(content_type || defaults.content_type, nil,
+            "charset" => (charset || defaults.charset))    
+        end  
+                     
+        part.set_content_disposition(content_disposition, squish("filename" => filename)) unless content_disposition.blank?
+        headers.each {|k,v| part[k] = v }
+        # END CHANGE
+
+      else
+        if String === body
+          part = TMail::Mail.new
+          part.body = body
+          part.set_content_type content_type, nil, { "charset" => charset }
+          part.set_content_disposition "inline"
+          m.parts << part
+        end
+          
+        @parts.each do |p|
+          prt = (TMail::Mail === p ? p : p.to_mail(defaults))
+          part.parts << prt
+        end
+        
+        part.set_content_type(content_type, nil, { "charset" => charset }) if content_type =~ /multipart/
+      end
+    
+      part
+    end
+  end
+end
+
+module ActionView
+  module Helpers #:nodoc:
+    module AssetTagHelper
+      def image_tag(source, options = {})
+        options.symbolize_keys!
+        
+        @part_container ||= @controller
+           
+        if @part_container.is_a?(ActionMailer::Base) or @part_container.is_a?(ActionMailer::Part)
+          file_path = "#{RAILS_ROOT}/public#{image_path(source).split('?').first}"
+          basename  = File.basename(file_path, '.*')
+          ext       = basename.split('.').last
+          cid       = Time.now.to_f.to_s + "#{basename}@inline_attachment"
+          file      = File.open(file_path, 'rb')
+          
+          @part_container.inline_attachment(:content_type => "image/#{ext}",
+                                        :body         => file.read,
+                                        :filename     => basename,
+                                        :cid          => "<#{cid}>",
+                                        :disposition  => "inline")
+          
+          options[:src] = "cid:#{cid}"
+          options[:alt] = basename.split('.').first.capitalize
+        else
+          options[:src] = image_path(source)
+          options[:alt] ||= File.basename(options[:src], '.*').split('.').first.capitalize
+        end
+        
+        if options[:size]
+          options[:width], options[:height] = options[:size].split("x") if options[:size] =~ %r{^\d+x\d+$}
+          options.delete(:size)
+        end
+
+        tag("img", options)
+      end
+    end
+  end
+end
+
+class DummyClass
+  def relative_url_root
+    ""
+  end
+end
+
+module ActionMailer #:nodoc:
+  class Base
+    def request
+      DummyClass.new
+    end
+  end
+end

data/lib/tmail_content_id.rb

@@ -0,0 +1,40 @@
+module TMail
+
+  class HeaderField   # redefine
+  
+      FNAME_TO_CLASS = {
+        'date'                      => DateTimeHeader,
+        'resent-date'               => DateTimeHeader,
+        'to'                        => AddressHeader,
+        'cc'                        => AddressHeader,
+        'bcc'                       => AddressHeader,
+        'from'                      => AddressHeader,
+        'reply-to'                  => AddressHeader,
+        'resent-to'                 => AddressHeader,
+        'resent-cc'                 => AddressHeader,
+        'resent-bcc'                => AddressHeader,
+        'resent-from'               => AddressHeader,
+        'resent-reply-to'           => AddressHeader,
+        'sender'                    => SingleAddressHeader,
+        'resent-sender'             => SingleAddressHeader,
+        'return-path'               => ReturnPathHeader,
+        'message-id'                => MessageIdHeader,
+        'resent-message-id'         => MessageIdHeader,
+        'in-reply-to'               => ReferencesHeader,
+        'received'                  => ReceivedHeader,
+        'references'                => ReferencesHeader,
+        'keywords'                  => KeywordsHeader,
+        'encrypted'                 => EncryptedHeader,
+        'mime-version'              => MimeVersionHeader,
+        'content-type'              => ContentTypeHeader,
+        'content-transfer-encoding' => ContentTransferEncodingHeader,
+        'content-disposition'       => ContentDispositionHeader,
+       # 'content-id'                => MessageIdHeader,
+        'subject'                   => UnstructuredHeader,
+        'comments'                  => UnstructuredHeader,
+        'content-description'       => UnstructuredHeader
+      }
+  
+  end
+
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: JasonKing-InlineAttachment
+version: !ruby/object:Gem::Version 
+  version: 0.3.3
+platform: ruby
+authors: 
+- Jason King
+- Edmond Leung
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-31 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.15"
+    version: 
+description: 
+email: jk@handle.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- lib/inline_attachment.rb
+- lib/tmail_content_id.rb
+has_rdoc: true
+homepage: http://github.com/JasonKing/inline_attachment
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Makes image_tag in an ActionMailer template embed the images in the emails
+test_files: []
+