@@ -1,16 +1,21 @@ module Mack module Mailer module Adapters # :nodoc: + # All mail adapters need to extend this class. class Base + # The origina Mack::Mailer object passed in. attr_accessor :mack_mailer - def initialize(mail) + def initialize(mail) # :nodoc: self.mack_mailer = mail end + # The transformed (ie, converted, object) needs_method :transformed + # Convert the Mack::Mailer object to the adapted object. needs_method :convert + # The RAW encoded String ready for delivery via SMTP, Sendmail, etc... needs_method :deliverable end # Base mack-mailer/lib/adapters/base.rb @@ -3,21 +3,23 @@ require 'base64' module Mack module Mailer module Adapters # :nodoc: + # Converts a Mack::Mailer object into a TMail object. class Tmail < Mack::Mailer::Adapters::Base - def to_s - - end - + # Returns the underlying TMail object. + # Raises Mack::Errors::UnconvertedMailer if the convert method hasn't + # been called first. def transformed raise Mack::Errors::UnconvertedMailer.new if @tmail.nil? @tmail end + # Returns the ready to be delivered encoded String def deliverable transformed.encoded end + # Converts the Mack::Mailer object to a TMail object. def convert @tmail = TMail::Mail.new @tmail.to = mack_mailer.to mack-mailer/lib/adapters/tmail.rb @@ -1,9 +1,11 @@ module Mack module Mailer + # Creates an attachment for a Mack::Mailer object. class Attachment + # Returns a String representing the body of the attachment. This String is NOT encoded in anyway! attr_accessor :body - attr_accessor :content_type + # Returns the name of the attached file. attr_accessor :file_name def initialize(body = nil) @@ -13,14 +15,15 @@ module Mack end end + # Takes an IO object and sets the body. You'll need to explicity set the file_name afterwards. def add_io(io) self.body = io.read end - def add_file(file, content_type = File.extname(file).gsub('.', '')) + # Takes a path to a file, reads it in, and sets the file_name based on the path. + def add_file(file) self.file_name = File.basename(file) self.body = File.read(file) - self.content_type = Mack::Utils::MimeTypes[content_type] end end # Attachment mack-mailer/lib/attachment.rb @@ -11,7 +11,7 @@ module Mack Net::SMTP.start(smtp_settings[:address], smtp_settings[:port], smtp_settings[:domain], smtp_settings[:user_name], smtp_settings[:password], smtp_settings[:authentication]) do |smtp| - smtp.sendmail(mail.deliverable, mail.reply_to, mail.destinations) + smtp.sendmail(mail.deliverable, mail.reply_to, mail.recipients) end end mack-mailer/lib/delivery_handlers/smtp.rb @@ -8,7 +8,7 @@ module Mack EmailRegistry.add(mail) end - class EmailRegistry < Mack::Utils::Registry + class EmailRegistry < Mack::Utils::Registry # :nodoc: end end # Test mack-mailer/lib/delivery_handlers/test.rb @@ -1,4 +1,5 @@ module Mack # :nodoc: + # The heart and soul of the mack-mailer package. module Mailer attr_accessor :to @@ -11,13 +12,17 @@ module Mack # :nodoc: attr_accessor :html_body attr_accessor :date_sent attr_accessor :mime_version + attr_accessor :content_type + # A helper method that takes a Hash and will populate the email with the key/value pairs of that Hash. def build(options = {}) options.each do |k,v| self.send("#{k}=", v) end end + # Returns the text_body of the email. If there is no text_body set it will attempt to build one using + # the text.erb template for this mailer. def text_body if @text_body.blank? @text_body = build_template(:text) @@ -25,6 +30,8 @@ module Mack # :nodoc: return @text_body end + # Returns the html_body of the email. If there is no html_body set it will attempt to build one using + # the html.erb template for this mailer. def html_body if @html_body.blank? @html_body = build_template(:html) @@ -32,10 +39,12 @@ module Mack # :nodoc: @html_body end + # Returns the mime_version of the email, defaults to "1.0" def mime_version (@mime_version ||= "1.0") end + # This will attempt to determine the content type of the email, unless one is already specified. def content_type return @content_type unless @content_type.blank? if has_attachments? @@ -49,35 +58,44 @@ module Mack # :nodoc: end end + # Returns the date sent, defaults to Time.now def date_sent (@date_sent ||= Time.now) end + # Returns the reply to address, defaults to the from address. def reply_to (@reply_to || self.from) end + # Adds a Mack::Mailer::Attachment to the email. + # Raise ArgumentError if the parameter is not a Mack::Mailer::Attachment def attach(file) raise ArgumentError.new unless file.is_a?(Mack::Mailer::Attachment) attachments << file end + # Returns true if there are attachments. def has_attachments? !attachments.empty? end + # Returns the attachments Array. def attachments @attachments ||= [] end + # Delivers the email with the configured Mack::Mailer::DeliveryHandlers class. def deliver(handler = app_config.mailer.deliver_with) "Mack::Mailer::DeliveryHandlers::#{handler.camelcase}".constantize.deliver(self) end - def destinations + # Returns all the recipients of this email. + def recipients [self.to, self.cc, self.bcc].flatten.compact end + # Returns a ready to be delivered, encoded, version of the email. def deliverable(adapter = app_config.mailer.adapter) adap = "Mack::Mailer::Adapters::#{adapter.camelcase}".constantize.new(self) adap.convert mack-mailer/lib/mailer.rb @@ -1,12 +1,22 @@ +# Generates the necessary files for a basic mailer. +# +# Example: +# rake generate:mailer name=welcome_email +# generates the following files: +# app/mailers/welcome_email.rb +# app/mailers/templates/welcome_email/text.erb +# app/mailers/templates/welcome_email/html.erb +# test/unit/welcome_email_spec.rb # => if using RSpec +# test/unit/welcome_email_test.rb # => if using Test::Unit::TestCase class MailerGenerator < Genosaurus require_param :name - def file_name + def file_name # :nodoc: param(:name).underscore.downcase end - def class_name + def class_name # :nodoc: param(:name).camelcase end mack-mailer/lib/mailer_generator/mailer_generator.rb @@ -1,9 +1,15 @@ module Mack # :nodoc: module Paths + # The path to the app/mailers directory. def self.mailers(*args) File.join(Mack.root, "app", "mailers", args) end + # The path to the app/mailers/templates directory. + def self.mailer_templates(*args) + Mack::Paths.mailers("templates", args) + end + end end \ No newline at end of file mack-mailer/lib/paths.rb @@ -1,10 +1,10 @@ module Mack - module Rendering - module Type - class Mailer < Mack::Rendering::Type::FileBase + module Rendering # :nodoc: + module Type # :nodoc: + class Mailer < Mack::Rendering::Type::FileBase # :nodoc: def render - x_file = Mack::Paths.mailers("templates", self.render_value, self.options[:format]) + x_file = Mack::Paths.mailer_templates(self.render_value, self.options[:format]) render_file(x_file) end mack-mailer/lib/rendering/type/mailer.rb @@ -11,7 +11,6 @@ describe Mack::Mailer::Attachment do it "should read in a file and set the content_type based on the extension" do at = Mack::Mailer::Attachment.new at.add_file(@my_file) - at.content_type.should == "image/png" at.body.should == File.read(@my_file) end @@ -31,14 +30,11 @@ describe Mack::Mailer::Attachment do it "should take a string and read call add_file" do at = Mack::Mailer::Attachment.new(@my_file) - at.content_type.should == "image/png" at.body.should == File.read(@my_file) end it "should take an IO and call add_io" do at = Mack::Mailer::Attachment.new(File.open(@my_file)) - at.content_type = "image/png" - at.content_type.should == "image/png" at.body.should == File.read(@my_file) end mack-mailer/spec/lib/attachment_spec.rb @@ -60,7 +60,7 @@ describe Mack::Mailer do @we.to = "mark@mackframework.com" @we.cc = ["foo@example.com", "bar@example.com"] @we.bcc = "fubar@example.com" - @we.destinations.should == ["mark@mackframework.com", "foo@example.com", "bar@example.com", "fubar@example.com"] + @we.recipients.should == ["mark@mackframework.com", "foo@example.com", "bar@example.com", "fubar@example.com"] end end mack-mailer/spec/lib/mack_mailer_spec.rb 424c5613226bbbc5876f4b3c5737420eebc77745 Mark Bates mark@markbates.com http://github.com/markbates/mack-more/commit/3fe046b8d040265fea50835c2cc2dd5b935f87af 3fe046b8d040265fea50835c2cc2dd5b935f87af 2008-07-24T13:01:21-07:00 2008-07-24T13:01:21-07:00 Feature: Mailer Support. [#24 state:resolved] 8ce18741489a1dea3bfaab847ed20128bddaf9a4 Mark Bates mark@markbates.com