Class: Mail::SMTP

Inherits:
Object
  • Object
show all
Defined in:
lib/mail/network/delivery_methods/smtp.rb

Overview

Sending Email with SMTP

Mail allows you to send emails using SMTP. This is done by wrapping Net::SMTP in an easy to use manner.

Sending via SMTP server on Localhost

Sending locally (to a postfix or sendmail server running on localhost) requires no special setup. Just to Mail.deliver &block or message.deliver! and it will be sent in this method.

Sending via MobileMe

Mail.defaults do
  delivery_method :smtp, { :address              => "smtp.me.com",
                           :port                 => 587,
                           :domain               => 'your.host.name',
                           :user_name            => '<username>',
                           :password             => '<password>',
                           :authentication       => 'plain',
                           :enable_starttls_auto => true  }
end

Sending via GMail

Mail.defaults do
  delivery_method :smtp, { :address              => "smtp.gmail.com",
                           :port                 => 587,
                           :domain               => 'your.host.name',
                           :user_name            => '<username>',
                           :password             => '<password>',
                           :authentication       => 'plain',
                           :enable_starttls_auto => true  }
end

Certificate verification

When using TLS, some mail servers provide certificates that are self-signed or whose names do not exactly match the hostname given in the address. OpenSSL will reject these by default. The best remedy is to use the correct hostname or update the certificate authorities trusted by your ruby. If that isn't possible, you can control this behavior with an :openssl_verify_mode setting. Its value may be either an OpenSSL verify mode constant (OpenSSL::SSL::VERIFY_NONE, OpenSSL::SSL::VERIFY_PEER), or a string containing the name of an OpenSSL verify mode (none, peer).

Others

Feel free to send me other examples that were tricky

Delivering the email

Once you have the settings right, sending the email is done by:

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!

Constant Summary collapse

DEFAULTS =
{
  :address              => 'localhost',
  :port                 => 25,
  :domain               => 'localhost.localdomain',
  :user_name            => nil,
  :password             => nil,
  :authentication       => nil,
  :enable_starttls      => nil,
  :enable_starttls_auto => true,
  :openssl_verify_mode  => nil,
  :ssl                  => nil,
  :tls                  => nil,
  :open_timeout         => nil,
  :read_timeout         => nil
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(values) ⇒ SMTP

Returns a new instance of SMTP



95
96
97
# File 'lib/mail/network/delivery_methods/smtp.rb', line 95

def initialize(values)
  self.settings = DEFAULTS.merge(values)
end

Instance Attribute Details

#settingsObject

Returns the value of attribute settings



77
78
79
# File 'lib/mail/network/delivery_methods/smtp.rb', line 77

def settings
  @settings
end

Instance Method Details

#deliver!(mail) ⇒ Object



99
100
101
102
103
104
105
# File 'lib/mail/network/delivery_methods/smtp.rb', line 99

def deliver!(mail)
  response = start_smtp_session do |smtp|
    Mail::SMTPConnection.new(:connection => smtp, :return_response => true).deliver!(mail)
  end

  settings[:return_response] ? response : self
end