mail_alternatives_with_attachments 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mail_alternatives_with_attachments.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,51 @@
+Why?
+====
+
+Spam filters often require that an HTML email also have a Text alternative that is generally the same as the HTML message. This means you need to send an email with a MIME type of `multipart/alternative` containing `text/html` and `text/plain` parts. ActionMailer 3 supports this scenario, but it falls apart when you need to add (inline) attachments to that mix. The property MIME hierarchy for an email like this is:
+
+* `multipart/mixed`
+    * `multipart/alternative`
+        * `multipart/related`
+            * `text/html`
+            * `image/png` (e.g. for an inline attachment; pdf would be another good example)
+        * `text/plain`
+    * `application/zip` (e.g for an attachment--not inline)
+
+If this seems more complicated then it should be, that's because it is. Thankfully, this gem allows you to create this entire hierarchy without all the hard work.
+
+Usage:
+======
+
+Including the `mail_alternatives_with_attachments` gem in your project will patch ActionMailer with the following two methods:
+
+* `ActionMailer::Base#prepare_message(headers={})`: This method does exactly what `ActionMailer::Base#mail(headers={})` does; however it doesn't automatically rendering of templates so that we add our own custom message parts.
+* `Mail::Message#alternative_content_types_with_attachment(options, &block)`: This method allows you to conveniently add all of the different parts of complex email with alternatives and attachments.
+
+Typically when using ActionMailer 3, you would create a message with the following code:
+
+    class MyEmailerClass < ActionMailer::Base
+      def my_email_method(address)
+        mail :to => address, 
+             :from => "noreply@myemail.com",
+             :subject => "My Subject"
+      end
+    end
+
+Using this gem to create an email with both alternatives and attachments you would use the following code:
+
+    class MyEmailerClass < ActionMailer::Base
+      def my_email_method(address, attachment, logo)
+        message = prepare_message to: address, subject: "My Subject", :content_type => "multipart/mixed"
+        
+        message.alternative_content_types_with_attachment(
+          :text => render_to_string(:template => "my_template.text"),
+          :html => render_to_string("my_template.html")
+        ) do |inline_attachments|
+          inline_attachments.inline['logo.png'] = logo
+        end
+        
+        attachments['attachment.pdf'] = attachment
+        
+        message
+      end
+    end

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mail_alternatives_with_attachments.rb

@@ -0,0 +1,6 @@
+require "mail_alternatives_with_attachments/version"
+
+module MailAlternativesWithAttachments
+  require "mail_alternatives_with_attachments/action_mailer_prepare_message"
+  require "mail_alternatives_with_attachments/mail_message_alternative_content_types_with_attachment"
+end

data/lib/mail_alternatives_with_attachments/action_mailer_prepare_message.rb

@@ -0,0 +1,49 @@
+module MailAlternativesWithAttachments::ActionMailerPrepareMessage
+
+  # Copied directly from ActionMailer::Base#mail but without
+  # the automatic rendering of templates.
+  def prepare_message(headers={})
+    # Guard flag to prevent both the old and the new API from firing
+    # Should be removed when old API is removed
+    @mail_was_called = true
+    m = @_message
+
+    # At the beginning, do not consider class default for parts order neither content_type
+    content_type = headers[:content_type]
+    parts_order  = headers[:parts_order]
+
+    # Call all the procs (if any)
+    default_values = self.class.default.merge(self.class.default) do |k,v|
+      v.respond_to?(:call) ? v.bind(self).call : v
+    end
+
+    # Handle defaults
+    headers = headers.reverse_merge(default_values)
+    headers[:subject] ||= default_i18n_subject
+
+    # Apply charset at the beginning so all fields are properly quoted
+    m.charset = charset = headers[:charset]
+
+    # Set configure delivery behavior
+    wrap_delivery_behavior!(headers.delete(:delivery_method))
+
+    # Assign all headers except parts_order, content_type and body
+    assignable = headers.except(:parts_order, :content_type, :body, :template_name, :template_path)
+    assignable.each { |k, v| m[k] = v }
+
+    # Setup content type, reapply charset and handle parts order
+    m.content_type = set_content_type(m, content_type, headers[:content_type])
+    m.charset      = charset
+
+    if m.multipart?
+      parts_order ||= headers[:parts_order]
+      m.body.set_sort_order(parts_order)
+      m.body.sort_parts!
+    end
+
+    m
+  end
+
+end
+
+ActionMailer::Base.send(:include, MailAlternativesWithAttachments::ActionMailerPrepareMessage)

data/lib/mail_alternatives_with_attachments/mail_message_alternative_content_types_with_attachment.rb

@@ -0,0 +1,32 @@
+module MailAlternativesWithAttachments::MailMessageAlternativeWithAttachment
+
+  def alternative_content_types_with_attachment(options, &block)
+    text_alternative = Mail::Part.new do
+      content_type "text/plain; charset=UTF-8"
+      body options[:text]
+    end
+
+    html_alternative = Mail::Part.new do
+      content_type 'text/html; charset=UTF-8'
+      body options[:html]
+    end
+
+    html_container = Mail::Part.new { content_type 'multipart/related' }
+    html_container.add_part html_alternative
+
+    alternative_bodies = Mail::Part.new { content_type 'multipart/alternative' }
+    alternative_bodies.add_part text_alternative
+    alternative_bodies.add_part html_container
+
+    add_part alternative_bodies
+
+    if block_given?
+      yield(html_container.attachments)
+    end
+
+    return self
+  end
+
+end
+
+Mail::Message.send(:include, MailAlternativesWithAttachments::MailMessageAlternativeWithAttachment)

data/lib/mail_alternatives_with_attachments/version.rb

@@ -0,0 +1,3 @@
+module MailAlternativesWithAttachments
+  VERSION = "1.0.0"
+end

data/mail_alternatives_with_attachments.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mail_alternatives_with_attachments/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mail_alternatives_with_attachments"
+  s.version     = MailAlternativesWithAttachments::VERSION
+  s.authors     = ["James Coleman"]
+  s.email       = ["jtc331@gmail.com"]
+  s.homepage    = "https://github.com/jcoleman/mail_alternatives_with_attachments"
+  s.summary     = %q{This gem makes it easy to send multipart alternative emails from ActionMailer 3}
+  s.description = %q{ActionMailer 3 makes it much easier to send emails, but there is one case it doesn't handle well.\
+ Specifically, it is difficult to send a message that has the proper MIME hiearchy for an email with both HTML and text alternatives\
+ that also includes attachments. This gem solves that need.}
+
+  s.rubyforge_project = "mail_alternatives_with_attachments"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: mail_alternatives_with_attachments
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- James Coleman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-24 00:00:00.000000000Z
+dependencies: []
+description: ! "ActionMailer 3 makes it much easier to send emails, but there is one
+  case it doesn't handle well.\\\n Specifically, it is difficult to send a message
+  that has the proper MIME hiearchy for an email with both HTML and text alternatives\\\n
+  that also includes attachments. This gem solves that need."
+email:
+- jtc331@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/mail_alternatives_with_attachments.rb
+- lib/mail_alternatives_with_attachments/action_mailer_prepare_message.rb
+- lib/mail_alternatives_with_attachments/mail_message_alternative_content_types_with_attachment.rb
+- lib/mail_alternatives_with_attachments/version.rb
+- mail_alternatives_with_attachments.gemspec
+homepage: https://github.com/jcoleman/mail_alternatives_with_attachments
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: mail_alternatives_with_attachments
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: This gem makes it easy to send multipart alternative emails from ActionMailer
+  3
+test_files: []