Parent

Files

Merb::Mailer

You’ll need a simple config like this in init.rb if you want to actually send mail:

Merb::Mailer.config = {
  :host   => 'smtp.yourserver.com',
  :port   => '25',
  :user   => 'user',
  :pass   => 'pass',
  :auth   => :plain # :plain, :login, :cram_md5, the default is no auth
  :domain => "localhost.localdomain" # the HELO domain provided by the client to the server
  :tls    => true/false/nil, true enables tls, default nil 
}

or

Merb::Mailer.config = {:sendmail_path => '/somewhere/odd'}
Merb::Mailer.delivery_method = :sendmail

You could send mail manually like this (but it’s better to use a MailController instead).

m = Merb::Mailer.new :to => 'foo@bar.com',
                     :from => 'bar@foo.com',
                     :subject => 'Welcome to whatever!',
                     :html => partial(:sometemplate)
m.deliver!

You can use :text option to specify plain text email body and :html for HTML email body.

Constants

VERSION

Attributes

mail[RW]

Public Class Methods

new(o={}) click to toggle source

Parameters

o<Hash{~to_s => Object}>

Configuration commands to send to MailFactory.

# File lib/merb-mailer/mailer.rb, line 116
def initialize(o={})
  self.config = { :sendmail_path => '/usr/sbin/sendmail' } if config.nil?
  o[:rawhtml] = o.delete(:html)
  m = MailFactory.new()
  o.each { |k,v| m.send "#{k}=", v }
  @mail = m
end

Public Instance Methods

attach(file_or_files, filename = file_or_files.is_a?(File) ? File.basename(file_or_files.path) : nil, type = nil, headers = nil) click to toggle source

Parameters

file_or_files<File, Array>

File(s) to attach.

filename<String>

type<~to_s>

The attachment MIME type. If left out, it will be determined from file_or_files.

headers<String, Array>

Additional attachment headers.

Raises

ArgumentError

file_or_files was not a File or an Array of File instances.

# File lib/merb-mailer/mailer.rb, line 97
def attach(file_or_files, filename = file_or_files.is_a?(File) ? File.basename(file_or_files.path) : nil,
  type = nil, headers = nil)
  if file_or_files.is_a?(Array)
    file_or_files.each do |v|
      if v.length < 2
        v << v.first.is_a?(File) ? File.basename(v.first.path) : nil
      end
      @mail.add_attachment_as *v
    end
  else
    if !file_or_files.is_a?(File) && !file_or_files.is_a?(StringIO)
      raise ArgumentError, "You did not pass in a file. Instead, you sent a #{file_or_files.class}" 
    end
    @mail.add_attachment_as(file_or_files, filename, type, headers)
  end
end
deliver!() click to toggle source

Delivers the mail with the specified delivery method, defaulting to net_smtp.

# File lib/merb-mailer/mailer.rb, line 82
def deliver!
  send(delivery_method || :net_smtp)
end
net_smtp() click to toggle source

Sends the mail using SMTP.

# File lib/merb-mailer/mailer.rb, line 57
def net_smtp
  smtp = Net::SMTP.new(config[:host], config[:port].to_i)
  if config[:tls]
    if smtp.respond_to?(:enable_starttls) # 1.9.x
      smtp.enable_starttls
    elsif smtp.respond_to?(:enable_tls) && smtp.respond_to?(:use_tls?)
      smtp.enable_tls(OpenSSL::SSL::VERIFY_NONE) # 1.8.x with tlsmail
    else
      raise 'Unable to enable TLS, for Ruby 1.8.x install tlsmail'
    end
  end
  smtp.start(config[:domain], config[:user], config[:pass], config[:auth]) { |smtp|
    @mail.to = [@mail.to] unless @mail.to.is_a?(Array)
    to = @mail.to.inject([]) {|r, e| r + e.split(/[,;]/) }.map {|e| e.strip}
    smtp.send_message(@mail.to_s, @mail.from.first, to)
  }
end
sendmail() click to toggle source

Sends the mail using sendmail.

# File lib/merb-mailer/mailer.rb, line 50
def sendmail
  sendmail = IO.popen("#{config[:sendmail_path]} #{@mail.to}", 'w+')
  sendmail.puts @mail.to_s
  sendmail.close
end
test_send() click to toggle source

Tests mail sending by adding the mail to deliveries.

# File lib/merb-mailer/mailer.rb, line 76
def test_send
  deliveries << @mail
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.