Merge pull request #34 from tmtm/add_mail_rcpt_params

add Net::SMTP::Address

Author: tmtm

lib/net/smtp.rb

@@ -274,11 +274,14 @@ def capable_starttls?
       capable?('STARTTLS')
     end
 
+    # true if the EHLO response contains +key+.
     def capable?(key)
       return nil unless @capabilities
       @capabilities[key] ? true : false
     end
-    private :capable?
+
+    # The server capabilities by EHLO response
+    attr_reader :capabilities
 
     # true if server advertises AUTH PLAIN.
     # You cannot get valid value before opening SMTP session.
@@ -703,9 +706,9 @@ def do_finish
     # binary message with this method. +msgstr+ should include both
     # the message headers and body.
     #
-    # +from_addr+ is a String representing the source mail address.
+    # +from_addr+ is a String or Net::SMTP::Address representing the source mail address.
     #
-    # +to_addr+ is a String or Strings or Array of Strings, representing
+    # +to_addr+ is a String or Net::SMTP::Address or Array of them, representing
     # the destination mail address or addresses.
     #
     # === Example
@@ -716,6 +719,12 @@ def do_finish
     #                         ['[email protected]', '[email protected]']
     #     end
     #
+    #     Net::SMTP.start('smtp.example.com') do |smtp|
+    #       smtp.send_message msgstr,
+    #                         Net::SMTP::Address.new('[email protected]', size: 12345),
+    #                         Net::SMTP::Address.new('[email protected]', notify: :success)
+    #     end
+    #
     # === Errors
     #
     # This method may raise:
@@ -752,9 +761,9 @@ def send_message(msgstr, from_addr, *to_addrs)
     #
     # === Parameters
     #
-    # +from_addr+ is a String representing the source mail address.
+    # +from_addr+ is a String or Net::SMTP::Address representing the source mail address.
     #
-    # +to_addr+ is a String or Strings or Array of Strings, representing
+    # +to_addr+ is a String or Net::SMTP::Address or Array of them, representing
     # the destination mail address or addresses.
     #
     # === Example
@@ -904,8 +913,10 @@ def ehlo(domain)
       getok("EHLO #{domain}")
     end
 
+    # +from_addr+ is +String+ or +Net::SMTP::Address+
     def mailfrom(from_addr)
-      getok("MAIL FROM:<#{from_addr}>")
+      addr = Address.new(from_addr)
+      getok((["MAIL FROM:<#{addr.address}>"] + addr.parameters).join(' '))
     end
 
     def rcptto_list(to_addrs)
@@ -916,7 +927,7 @@ def rcptto_list(to_addrs)
         begin
           rcptto addr
         rescue SMTPAuthenticationError
-          unknown_users << addr.dump
+          unknown_users << addr.to_s.dump
         else
           ok_users << addr
         end
@@ -929,8 +940,10 @@ def rcptto_list(to_addrs)
       ret
     end
 
+    # +to_addr+ is +String+ or +Net::SMTP::Address+
     def rcptto(to_addr)
-      getok("RCPT TO:<#{to_addr}>")
+      addr = Address.new(to_addr)
+      getok((["RCPT TO:<#{addr.address}>"] + addr.parameters).join(' '))
     end
 
     # This method sends a message.
@@ -1139,6 +1152,33 @@ def logging(msg)
       @debug_output << msg + "\n" if @debug_output
     end
 
+    # Address with parametres for MAIL or RCPT command
+    class Address
+      # mail address [String]
+      attr_reader :address
+      # paramters [Array<String>]
+      attr_reader :parameters
+
+      # :call-seq:
+      #  initialize(address, parameter, ...)
+      #
+      # address +String+ or +Net::SMTP::Address+
+      # parameter +String+ or +Hash+
+      def initialize(address, *args, **kw_args)
+        if address.kind_of? Address
+          @address = address.address
+          @parameters = address.parameters
+        else
+          @address = address
+          @parameters = (args + [kw_args]).map{|param| Array(param)}.flatten(1).map{|param| Array(param).compact.join('=')}
+        end
+      end
+
+      def to_s
+        @address
+      end
+    end
+
   end   # class SMTP
 
   SMTPSession = SMTP # :nodoc:

test/net/smtp/test_smtp.rb

@@ -70,6 +70,15 @@ def test_esmtp
       assert_equal 'omg', smtp.esmtp?
     end
 
+    def test_server_capabilities
+      port = fake_server_start(starttls: true)
+      smtp = Net::SMTP.start('localhost', port, starttls: false)
+      assert_equal({"STARTTLS"=>[], "AUTH"=>["PLAIN"]}, smtp.capabilities)
+      assert_equal(true, smtp.capable?('STARTTLS'))
+      assert_equal(false, smtp.capable?('SMTPUTF8'))
+      smtp.finish
+    end
+
     def test_rset
       smtp = Net::SMTP.new 'localhost', 25
       smtp.instance_variable_set :@socket, FakeSocket.new
@@ -85,6 +94,15 @@ def test_mailfrom
       assert_equal "MAIL FROM:<[email protected]>\r\n", sock.write_io.string
     end
 
+    def test_mailfrom_with_address
+      sock = FakeSocket.new
+      smtp = Net::SMTP.new 'localhost', 25
+      smtp.instance_variable_set :@socket, sock
+      addr = Net::SMTP::Address.new("[email protected]", size: 12345)
+      assert smtp.mailfrom(addr).success?
+      assert_equal "MAIL FROM:<[email protected]> size=12345\r\n", sock.write_io.string
+    end
+
     def test_rcptto
       sock = FakeSocket.new
       smtp = Net::SMTP.new 'localhost', 25
@@ -93,6 +111,21 @@ def test_rcptto
       assert_equal "RCPT TO:<[email protected]>\r\n", sock.write_io.string
     end
 
+    def test_rcptto_with_address
+      sock = FakeSocket.new
+      smtp = Net::SMTP.new 'localhost', 25
+      smtp.instance_variable_set :@socket, sock
+      addr = Net::SMTP::Address.new("[email protected]", nofty: :failure)
+      assert smtp.rcptto(addr).success?
+      assert_equal "RCPT TO:<[email protected]> nofty=failure\r\n", sock.write_io.string
+    end
+
+    def test_address
+      a = Net::SMTP::Address.new('[email protected]', 'p0=123', {p1: 456}, p2: nil, p3: '789')
+      assert_equal '[email protected]', a.address
+      assert_equal ['p0=123', 'p1=456', 'p2', 'p3=789'], a.parameters
+    end
+
     def test_auth_plain
       sock = FakeSocket.new
       smtp = Net::SMTP.new 'localhost', 25