Class: Mail::Sendmail

Inherits:
Object show all
Includes:
CheckDeliveryParams
Defined in:
lib/mail/network/delivery_methods/sendmail.rb

Overview

A delivery method implementation which sends via sendmail.

To use this, first find out where the sendmail binary is on your computer, if you are on a mac or unix box, it is usually in /usr/sbin/sendmail, this will be your sendmail location.

Mail.defaults do
  delivery_method :sendmail
end

Or if your sendmail binary is not at '/usr/sbin/sendmail'

Mail.defaults do
  delivery_method :sendmail, :location => '/absolute/path/to/your/sendmail'
end

Then just deliver the email as normal:

Mail.deliver do
  to 'mikel@test.lindsaar.net'
  from 'ada@test.lindsaar.net'
  subject 'testing sendmail'
  body 'testing sendmail'
end

Or by calling deliver on a Mail message

mail = Mail.new do
  to 'mikel@test.lindsaar.net'
  from 'ada@test.lindsaar.net'
  subject 'testing sendmail'
  body 'testing sendmail'
end

mail.deliver!

Direct Known Subclasses

Exim

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from CheckDeliveryParams

#check_delivery_params

Constructor Details

- (Sendmail) initialize(values)

Returns a new instance of Sendmail



42
43
44
45
# File 'lib/mail/network/delivery_methods/sendmail.rb', line 42

def initialize(values)
  self.settings = { :location       => '/usr/sbin/sendmail',
                    :arguments      => '-i' }.merge(values)
end

Instance Attribute Details

- (Object) settings

Returns the value of attribute settings



47
48
49
# File 'lib/mail/network/delivery_methods/sendmail.rb', line 47

def settings
  @settings
end

Class Method Details

+ (Object) call(path, arguments, destinations, encoded_message)



59
60
61
62
63
64
# File 'lib/mail/network/delivery_methods/sendmail.rb', line 59

def self.call(path, arguments, destinations, encoded_message)
  popen "#{path} #{arguments} #{destinations}" do |io|
    io.puts encoded_message.to_lf
    io.flush
  end
end

+ (Object) popen(command, &block)



67
68
69
# File 'lib/mail/network/delivery_methods/sendmail.rb', line 67

def self.popen(command, &block)
  IO.popen "#{command} 2>&1", 'w+', &block
end

+ (Object) shellquote(address)

The following is an adaptation of ruby 1.9.2's shellwords.rb file, it is modified to include '+' in the allowed list to allow for sendmail to accept email addresses as the sender with a + in them.



79
80
81
82
83
84
85
86
87
# File 'lib/mail/network/delivery_methods/sendmail.rb', line 79

def self.shellquote(address)
  # Process as a single byte sequence because not all shell
  # implementations are multibyte aware.
  #
  # A LF cannot be escaped with a backslash because a backslash + LF
  # combo is regarded as line continuation and simply ignored. Strip it.
  escaped = address.gsub(/([^A-Za-z0-9_\s\+\-.,:\/@])/n, "\\\\\\1").gsub("\n", '')
  %("#{escaped}")
end

Instance Method Details

- (Object) deliver!(mail)



49
50
51
52
53
54
55
56
57
# File 'lib/mail/network/delivery_methods/sendmail.rb', line 49

def deliver!(mail)
  smtp_from, smtp_to, message = check_delivery_params(mail)

  from = "-f #{self.class.shellquote(smtp_from)}"
  to = smtp_to.map { |_to| self.class.shellquote(_to) }.join(' ')

  arguments = "#{settings[:arguments]} #{from} --"
  self.class.call(settings[:location], arguments, to, message)
end