mail-portertech 2.6.2.edge

data/lib/mail/network.rb

@@ -0,0 +1,14 @@
+require 'mail/network/retriever_methods/base'
+
+module Mail
+  register_autoload :SMTP, 'mail/network/delivery_methods/smtp'
+  register_autoload :FileDelivery, 'mail/network/delivery_methods/file_delivery'
+  register_autoload :Sendmail, 'mail/network/delivery_methods/sendmail'
+  register_autoload :Exim, 'mail/network/delivery_methods/exim'
+  register_autoload :SMTPConnection, 'mail/network/delivery_methods/smtp_connection'
+  register_autoload :TestMailer, 'mail/network/delivery_methods/test_mailer'
+
+  register_autoload :POP3, 'mail/network/retriever_methods/pop3'
+  register_autoload :IMAP, 'mail/network/retriever_methods/imap'
+  register_autoload :TestRetriever, 'mail/network/retriever_methods/test_retriever'
+end

data/lib/mail/network/delivery_methods/exim.rb

@@ -0,0 +1,52 @@
+module Mail
+
+  # A delivery method implementation which sends via exim.
+  #
+  # To use this, first find out where the exim binary is on your computer,
+  # if you are on a mac or unix box, it is usually in /usr/sbin/exim, this will
+  # be your exim location.
+  #
+  #   Mail.defaults do
+  #     delivery_method :exim
+  #   end
+  #
+  # Or if your exim binary is not at '/usr/sbin/exim'
+  #
+  #   Mail.defaults do
+  #     delivery_method :exim, :location => '/absolute/path/to/your/exim'
+  #   end
+  #
+  # Then just deliver the email as normal:
+  #
+  #   Mail.deliver do
+  #     to 'mikel@test.lindsaar.net'
+  #     from 'ada@test.lindsaar.net'
+  #     subject 'testing exim'
+  #     body 'testing exim'
+  #   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 exim'
+  #     body 'testing exim'
+  #   end
+  #
+  #   mail.deliver!
+  class Exim < Sendmail
+    def initialize(values)
+      self.settings = { :location       => '/usr/sbin/exim',
+                        :arguments      => '-i -t' }.merge(values)
+    end
+
+    def self.call(path, arguments, destinations, mail)
+      popen "#{path} #{arguments}" do |io|
+        io.puts mail.encoded.to_lf
+        io.flush
+      end
+    end
+
+  end
+end

data/lib/mail/network/delivery_methods/file_delivery.rb

@@ -0,0 +1,45 @@
+require 'mail/check_delivery_params'
+
+module Mail
+  
+  # FileDelivery class delivers emails into multiple files based on the destination
+  # address.  Each file is appended to if it already exists.
+  # 
+  # So if you have an email going to fred@test, bob@test, joe@anothertest, and you
+  # set your location path to /path/to/mails then FileDelivery will create the directory
+  # if it does not exist, and put one copy of the email in three files, called
+  # by their message id
+  # 
+  # Make sure the path you specify with :location is writable by the Ruby process
+  # running Mail.
+  class FileDelivery
+    include Mail::CheckDeliveryParams
+
+    if RUBY_VERSION >= '1.9.1'
+      require 'fileutils'
+    else
+      require 'ftools'
+    end
+
+    def initialize(values)
+      self.settings = { :location => './mails' }.merge!(values)
+    end
+    
+    attr_accessor :settings
+    
+    def deliver!(mail)
+      check_delivery_params(mail)
+
+      if ::File.respond_to?(:makedirs)
+        ::File.makedirs settings[:location]
+      else
+        ::FileUtils.mkdir_p settings[:location]
+      end
+
+      mail.destinations.uniq.each do |to|
+        ::File.open(::File.join(settings[:location], File.basename(to.to_s)), 'a') { |f| "#{f.write(mail.encoded)}\r\n\r\n" }
+      end
+    end
+    
+  end
+end

data/lib/mail/network/delivery_methods/sendmail.rb

@@ -0,0 +1,89 @@
+require 'mail/check_delivery_params'
+
+module Mail
+  # 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!
+  class Sendmail
+    include Mail::CheckDeliveryParams
+
+    def initialize(values)
+      self.settings = { :location       => '/usr/sbin/sendmail',
+                        :arguments      => '-i' }.merge(values)
+    end
+
+    attr_accessor :settings
+
+    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
+
+    def self.call(path, arguments, destinations, encoded_message)
+      popen "#{path} #{arguments} #{destinations}" do |io|
+        io.puts encoded_message.to_lf
+        io.flush
+      end
+    end
+
+    if RUBY_VERSION < '1.9.0'
+      def self.popen(command, &block)
+        IO.popen "#{command} 2>&1", 'w+', &block
+      end
+    else
+      def self.popen(command, &block)
+        IO.popen command, 'w+', :err => :out, &block
+      end
+    end
+
+    # 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.
+    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
+  end
+end

data/lib/mail/network/delivery_methods/smtp.rb

@@ -0,0 +1,142 @@
+require 'mail/check_delivery_params'
+
+module Mail
+  # == 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), or a string containing
+  # the name of an OpenSSL verify mode (none, peer, client_once,
+  # fail_if_no_peer_cert).
+  #
+  # === 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!
+  class SMTP
+    include Mail::CheckDeliveryParams
+
+    def initialize(values)
+      self.settings = { :address              => "localhost",
+                        :port                 => 25,
+                        :domain               => 'localhost.localdomain',
+                        :user_name            => nil,
+                        :password             => nil,
+                        :authentication       => nil,
+                        :enable_starttls_auto => true,
+                        :openssl_verify_mode  => nil,
+                        :ssl                  => nil,
+                        :tls                  => nil
+                      }.merge!(values)
+    end
+
+    attr_accessor :settings
+
+    # Send the message via SMTP.
+    # The from and to attributes are optional. If not set, they are retrieve from the Message.
+    def deliver!(mail)
+      smtp_from, smtp_to, message = check_delivery_params(mail)
+
+      smtp = Net::SMTP.new(settings[:address], settings[:port])
+      if settings[:tls] || settings[:ssl]
+        if smtp.respond_to?(:enable_tls)
+          smtp.enable_tls(ssl_context)
+        end
+      elsif settings[:enable_starttls_auto]
+        if smtp.respond_to?(:enable_starttls_auto)
+          smtp.enable_starttls_auto(ssl_context)
+        end
+      end
+
+      response = nil
+      smtp.start(settings[:domain], settings[:user_name], settings[:password], settings[:authentication]) do |smtp_obj|
+        response = smtp_obj.sendmail(message, smtp_from, smtp_to)
+      end
+
+      if settings[:return_response]
+        response
+      else
+        self
+      end
+    end
+    
+
+    private
+
+    # Allow SSL context to be configured via settings, for Ruby >= 1.9
+    # Just returns openssl verify mode for Ruby 1.8.x
+    def ssl_context
+      openssl_verify_mode = settings[:openssl_verify_mode]
+
+      if openssl_verify_mode.kind_of?(String)
+        openssl_verify_mode = "OpenSSL::SSL::VERIFY_#{openssl_verify_mode.upcase}".constantize
+      end
+
+      context = Net::SMTP.default_ssl_context
+      context.verify_mode = openssl_verify_mode
+      context.ca_path = settings[:ca_path] if settings[:ca_path]
+      context.ca_file = settings[:ca_file] if settings[:ca_file]
+      context
+    end
+  end
+end

data/lib/mail/network/delivery_methods/smtp_connection.rb

@@ -0,0 +1,61 @@
+require 'mail/check_delivery_params'
+
+module Mail
+  # == Sending Email with SMTP
+  # 
+  # Mail allows you to send emails using an open SMTP connection.  This is done by
+  # passing a created Net::SMTP object.  This way we can get better performance to
+  # our local mail server by reducing the number of connections at any one time.
+  #
+  # === Sending via SMTP server on Localhost
+  # 
+  # To send mail open a connection with Net::Smtp using any options you like
+  # === Delivering the email
+  # 
+  # Once you have the settings right, sending the email is done by:
+  #
+  #   smtp_conn = Net::SMTP.start(settings[:address], settings[:port])
+  #   Mail.defaults do
+  #     delivery_method :smtp_connection, { :connection => smtp_conn }
+  #   end
+  # 
+  #   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!
+  class SMTPConnection
+    include Mail::CheckDeliveryParams
+
+    def initialize(values)
+      raise ArgumentError.new('A Net::SMTP object is required for this delivery method') if values[:connection].nil?
+      self.smtp = values[:connection]
+      self.settings = values
+    end
+
+    attr_accessor :smtp
+    attr_accessor :settings
+
+    # Send the message via SMTP.
+    # The from and to attributes are optional. If not set, they are retrieve from the Message.
+    def deliver!(mail)
+      smtp_from, smtp_to, message = check_delivery_params(mail)
+      response = smtp.sendmail(message, smtp_from, smtp_to)
+
+      settings[:return_response] ? response : self
+    end
+
+  end
+end

data/lib/mail/network/delivery_methods/test_mailer.rb

@@ -0,0 +1,44 @@
+require 'mail/check_delivery_params'
+
+module Mail
+  # The TestMailer is a bare bones mailer that does nothing.  It is useful
+  # when you are testing.
+  # 
+  # It also provides a template of the minimum methods you require to implement
+  # if you want to make a custom mailer for Mail
+  class TestMailer
+    include Mail::CheckDeliveryParams
+
+    # Provides a store of all the emails sent with the TestMailer so you can check them.
+    def TestMailer.deliveries
+      @@deliveries ||= []
+    end
+
+    # Allows you to over write the default deliveries store from an array to some
+    # other object.  If you just want to clear the store, 
+    # call TestMailer.deliveries.clear.
+    # 
+    # If you place another object here, please make sure it responds to:
+    # 
+    # * << (message)
+    # * clear
+    # * length
+    # * size
+    # * and other common Array methods
+    def TestMailer.deliveries=(val)
+      @@deliveries = val
+    end
+
+    def initialize(values)
+      @settings = values.dup
+    end
+    
+    attr_accessor :settings
+
+    def deliver!(mail)
+      check_delivery_params(mail)
+      Mail::TestMailer.deliveries << mail
+    end
+    
+  end
+end