sisimai 5.1.0 → 5.2.0

data/lib/sisimai/smtp/failure.rb

@@ -0,0 +1,103 @@
+module Sisimai
+  module SMTP
+    # Sisimai::SMTP::Failure is utilities for checking SMTP Errors from error message text.
+    module Failure
+      class << self
+        require 'sisimai/smtp/reply'
+        require 'sisimai/smtp/status'
+
+        # Returns true if the given string indicates a permanent error
+        # @param    [String] argv1  String including SMTP Status code
+        # @return   [Boolean]       true:  Permanet error
+        #                           false: Is not a permanent error
+        # @since v4.17.3
+        def is_permanent(argv1 = '')
+          return false unless argv1
+          return false unless argv1.size > 0
+
+          statuscode = Sisimai::SMTP::Status.find(argv1)
+          statuscode = Sisimai::SMTP::Reply.find(argv1) if statuscode.empty?
+          return true if statuscode[0, 1] == "5"
+          return true if argv1.downcase.include?(' permanent ')
+          return false
+        end
+
+        # Returns true if the given string indicates a temporary error
+        # @param    [String] argv1  String including SMTP Status code
+        # @return   [Boolean]       true:  Temporary error
+        #                           false: is not a temporary error
+        # @since v5.2.0
+        def is_temporary(argv1 = '')
+          return false unless argv1
+          return false unless argv1.size > 0
+
+          statuscode = Sisimai::SMTP::Status.find(argv1);
+          statuscode = Sisimai::SMTP::Reply.find(argv1) if statuscode.empty?
+          issuedcode = argv1.downcase
+
+          return true if statuscode[0, 1] == "4"
+          return true if issuedcode.include?(' temporar')
+          return true if issuedcode.include?(' persistent')
+          return false
+        end
+
+        # Checks the reason sisimai detected is a hard bounce or not
+        # @param    [String] argv1  Detected bounce reason
+        # @param    [String] argv2  String including SMTP Status code
+        # @return   [Boolean]       true: is a hard bounce
+        def is_hardbounce(argv1 = '', argv2 = '')
+          return false unless argv1
+          return false unless argv1.size > 0
+
+          return false if argv1 == "undefined" || argv1 == "onhold"
+          return false if argv1 == "delivered" || argv1 == "feedback"    || argv1 == "vacation"
+          return true  if argv1 == "hasmoved"  || argv1 == "userunknown" || argv1 == "hostunknown"
+          return false if argv1 != "notaccept" 
+
+          # NotAccept: 5xx => hard bounce, 4xx => soft bounce
+          hardbounce = false
+          if argv2.size > 0
+            # Check the 2nd argument(a status code or a reply code)
+            cv = Sisimai::SMTP::Status.find(argv2, "")
+            cv = Sisimai::SMTP::Reply.find(argv2, "") if cv.empty?
+
+            # The SMTP status code or the SMTP reply code starts with "5"
+            # Deal as a hard bounce when the error message does not indicate a temporary error 
+            hardbounce = true if cv[0, 1] == "5" || Sisimai::SMTP::Failure.is_temporary(argv2) == false
+          else
+            # Deal "NotAccept" as a hard bounce when the 2nd argument is empty
+            hardbounce = true
+          end
+          return hardbounce
+        end
+
+        # Checks the reason sisimai detected is a soft bounce or not
+        # @param    [String] argv1  Detected bounce reason
+        # @param    [String] argv2  String including SMTP Status code
+        # @return   [Boolean]       true: is a soft bounce
+        def is_softbounce(argv1 = '', argv2 = '')
+          return false unless argv1
+          return false unless argv1.size > 0
+
+          return false if argv1 == "delivered" || argv1 == "feedback"    || argv1 == "vacation"
+          return false if argv1 == "hasmoved"  || argv1 == "userunknown" || argv1 == "hostunknown"
+          return true  if argv1 == "undefined" || argv1 == "onhold"
+          return true  if argv1 != "notaccept" 
+
+          # NotAccept: 5xx => hard bounce, 4xx => soft bounce
+          softbounce = false
+          if argv2.size > 0
+            # Check the 2nd argument(a status code or a reply code)
+            cv = Sisimai::SMTP::Status.find(argv2, "")
+            cv = Sisimai::SMTP::Reply.find(argv2, "") if cv.empty?
+
+            # The SMTP status code or the SMTP reply code starts with "4"
+            softbounce = true if cv[0, 1] == "4"
+          end
+          return softbounce
+        end
+
+      end
+    end
+  end
+end

data/lib/sisimai/smtp/reply.rb

@@ -1,4 +1,5 @@
 # http://www.ietf.org/rfc/rfc5321.txt
+# -------------------------------------------------------------------------------------------------
 #   4.2.1.  Reply Code Severities and Theory
 #
 #   There are four values for the first digit of the reply code:
@@ -103,32 +104,32 @@ module Sisimai
           # 554   Transaction failed (Or, in the case of a connection-opening response, "No SMTP service here")
           # 555   MAIL FROM/RCPT TO parameters not recognized or not implemented
           # 556   Domain does not accept mail (See RFC7504)
+          # 557   draft-moore-email-addrquery-01
           '550', '552', '553', '551', '521', '525', '502', '520', '523', '524', '530', '533', '534',
-          '535', '538', '551', '555', '556', '554', '500', '501', '502', '503', '504',
+          '535', '538', '551', '555', '556', '554', '557', '500', '501', '502', '503', '504',
         ].freeze
         CodeOfSMTP = { '2' => ReplyCode2, '4' => ReplyCode4, '5' => ReplyCode5 }.freeze
 
         # Check whether a reply code is a valid code or not
         # @param    [String] argv1  Reply Code(DSN)
-        # @return   [Boolean]       0 = Invalid reply code, 1 = Valid reply code
+        # @return   [Boolean]       false = Invalid reply code, true = Valid reply code
         # @see      code
         # @since v5.0.0
         def test(argv1 = '')
-          return nil if argv1.empty?
+          return false if argv1.empty?
 
           reply = argv1.to_i
           first = (reply / 100).to_i
 
-          return false if reply < 200
-          return false if reply > 599
+          return false if reply < 211
+          return false if reply > 557
           return false if reply % 100 > 59
 
           if first == 2
             # 2yz
-            return true  if reply == 235
-            return false if reply <  211
-            return false if reply >  252
-            return false if reply >  221 && reply < 250
+            return true  if reply == 235                # 235 is a valid code for AUTH (RFC4954)
+            return false if reply >  253                # The maximum code of 2xy is 253 (RFC5248)
+            return false if reply >  221 && reply < 250 # There is no reply code between 221 and 250 
             return true
           end
 
@@ -147,34 +148,37 @@ module Sisimai
         # @return   [String]        SMTP Reply Code
         #           [Nil]           The first argument did not include SMTP Reply Code value
         def find(argv1 = '', argv2 = '0')
-          return nil if argv1.to_s.size < 3
-          return nil if argv1.upcase.include?('X-UNIX')
+          return "" if argv1.to_s.size < 3
+          return "" if argv1.upcase.include?('X-UNIX')
 
+          esmtperror = ' ' + argv1 + ' '
+          esmtpreply = ''
           statuscode = argv2[0, 1]
           replycodes = if statuscode == '5' || statuscode == '4' || statuscode == '2'
                          CodeOfSMTP[statuscode]
                        else
                          [*CodeOfSMTP['5'], *CodeOfSMTP['4'], *CodeOfSMTP['2']]
                        end
-          esmtperror = ' ' + argv1 + ' '
-          esmtpreply = '' # SMTP Reply Code
-          replyindex =  0 # A position of SMTP reply code found by the index()
-          formerchar =  0 # a character that is one character before the SMTP reply code
-          latterchar =  0 # a character that is one character after  the SMTP reply code
 
           replycodes.each do |e|
             # Try to find an SMTP Reply Code from the given string
-            replyindex = esmtperror.index(e); next unless replyindex
-            formerchar = esmtperror[replyindex - 1, 1].ord || 0
-            latterchar = esmtperror[replyindex + 3, 1].ord || 0
+            appearance = esmtperror.index(e); next if appearance.nil?
+            startingat = 1
+            mesglength = esmtperror.size
 
-            next if formerchar > 45 && formerchar < 58
-            next if latterchar > 45 && latterchar < 58
-            esmtpreply = e
-            break
-          end
+            while startingat + 3 < mesglength
+              # Find all the reply code in the error message
+              replyindex = esmtperror.index(e, startingat); break if replyindex.nil?
+              formerchar = esmtperror[replyindex - 1, 1].ord || 0
+              latterchar = esmtperror[replyindex + 3, 1].ord || 0
 
-          return nil if esmtpreply.empty?
+              if formerchar > 45 && formerchar < 58 then startingat += 3; next; end
+              if latterchar > 45 && latterchar < 58 then startingat += 3; next; end
+              esmtpreply = e
+              break
+            end
+            break if esmtpreply != ""
+          end
           return esmtpreply
         end
 

data/lib/sisimai/smtp/status.rb

@@ -479,6 +479,8 @@ module Sisimai
     # reason from D.S.N. value, and getting D.S.N. from the text including D.S.N.
     module Status
       class << self
+        require "sisimai/rfc791"
+
         CodePatterns = [
           %r/[ ]?[(][#]([45][.]\d[.]\d+)[)]?[ ]?/,  # #5.5.1
           %r/\b\d{3}[- ][#]?([45][.]\d[.]\d+)\b/,   # 550-5.1.1 OR 550 5.5.1
@@ -492,7 +494,7 @@ module Sisimai
           '4.1.7'  => 'rejected',       # Bad sender's mailbox address syntax
           '4.1.8'  => 'rejected',       # Bad sender's system address
           '4.1.9'  => 'systemerror',    # Message relayed to non-compliant mailer
-          '4.2.1'  => 'suspend',        # Mailbox disabled, not accepting messages
+          '4.2.1'  => 'blocked',        # Mailbox disabled, not accepting messages
           '4.2.2'  => 'mailboxfull',    # Mailbox full
           '4.2.3'  => 'exceedlimit',    # Message length exceeds administrative limit
           '4.2.4'  => 'filtered',       # Mailing list expansion problem
@@ -595,47 +597,53 @@ module Sisimai
           '5.7.27' => 'notaccept',      # MX resource record of a destination host is Null MX: RFC7505
           '5.7.28' => 'spamdetected',   # The message appears to be part of a mail flood of similar abusive messages.
           '5.7.29' => 'authfailure',    # This status code may be returned when a message fails ARC validation.
-          '5.7.30' => 'securityerror',  # REQUIRETLS support required
+          '5.7.30' => 'failedstarttls', # REQUIRETLS support required
         }.freeze
 
         InternalCode = {
           :temporary => {
-            'authfailure'     => '4.0.972',
+            'authfailure'     => '4.0.926',
             'badreputation'   => '4.0.975',
             'blocked'         => '4.0.971',
             'contenterror'    => '4.0.960',
-            # 'exceedlimit'   => '4.0.923',
+            'exceedlimit'     => '4.0.923',
             'expired'         => '4.0.947',
+            'failedstarttls'  => '4.0.976',
             'filtered'        => '4.0.924',
             # 'hasmoved'      => '4.0.916',
             # 'hostunknown'   => '4.0.912',
             'mailboxfull'     => '4.0.922',
-            # 'mailererror'   => '4.0.939',
-            # 'mesgtoobig'    => '4.0.934',
+            'mailererror'     => '4.0.939',
+            'mesgtoobig'      => '4.0.934',
             'networkerror'    => '4.0.944',
-            # 'norelaying'    => '4.0.909',
+            'norelaying'      => '4.0.909',
             'notaccept'       => '4.0.932',
             'notcompliantrfc' => '4.0.974',
             'onhold'          => '4.0.901',
+            'policyviolaton'  => '4.0.972',
             'rejected'        => '4.0.918',
             'requireptr'      => '4.0.973',
             'securityerror'   => '4.0.970',
             'spamdetected'    => '4.0.980',
             'speeding'        => '4.0.946',
-            # 'suspend'       => '4.0.921',
+            'suppressed'      => '4.0.903',
+            'suspend'         => '4.0.921',
             'systemerror'     => '4.0.930',
             'systemfull'      => '4.0.931',
+            'syntaxerror'     => '4.0.902',
             'toomanyconn'     => '4.0.945',
             # 'userunknown'   => '4.0.911',
             'undefined'       => '4.0.900',
+            'virusdetected'   => '4.0.981',
           },
           :permanent => {
-            'authfailure'     => '5.0.972',
+            'authfailure'     => '5.0.926',
             'badreputation'   => '5.0.975',
             'blocked'         => '5.0.971',
             'contenterror'    => '5.0.960',
             'exceedlimit'     => '5.0.923',
             'expired'         => '5.0.947',
+            'failedstarttls'  => '5.0.976',
             'filtered'        => '5.0.910',
             'hasmoved'        => '5.0.916',
             'hostunknown'     => '5.0.912',
@@ -653,6 +661,7 @@ module Sisimai
             'securityerror'   => '5.0.970',
             'spamdetected'    => '5.0.980',
             'speeding'        => '5.0.946',
+            'suppressed'      => '5.0.903',
             'suspend'         => '5.0.921',
             'systemerror'     => '5.0.930',
             'systemfull'      => '5.0.931',
@@ -660,7 +669,7 @@ module Sisimai
             'toomanyconn'     => '5.0.945',
             'userunknown'     => '5.0.911',
             'undefined'       => '5.0.900',
-            'virusdetected'   => '5.0.971',
+            'virusdetected'   => '5.0.981',
           },
         }.freeze
 
@@ -696,7 +705,7 @@ module Sisimai
         # @see      code
         # @since v5.0.0
         def test(argv1 = '')
-          return nil   if argv1.to_s.empty?
+          return false if argv1.to_s.empty?
           return false if argv1.size < 5
           return false if argv1.size > 7
 
@@ -717,8 +726,8 @@ module Sisimai
         # @param    [String] argv2  An SMTP Reply Code or 2 or 4 or 5
         # @return   [String, Nil]   An SMTP Status Code
         def find(argv1 = nil, argv2 = '0')
-          return nil if argv1.to_s.empty?
-          return nil if argv1.size < 7
+          return "" if argv1.to_s.empty?
+          return "" if argv1.size < 7
 
           givenclass = argv2[0, 1]
           eestatuses = if givenclass == '2' || givenclass == '4' || givenclass == '5' 
@@ -729,7 +738,7 @@ module Sisimai
           esmtperror = ' ' + argv1 + ' '
           lookingfor = []
 
-          Sisimai::String.ipv4(esmtperror).each do |e|
+          Sisimai::RFC791.find(esmtperror).each do |e|
             # Rewrite an IPv4 address in the given string(argv1) with '***.***.***.***'
             p0 = esmtperror.index(e) || next
             esmtperror[p0, e.size] = '***.***.***.***'
@@ -745,7 +754,7 @@ module Sisimai
               p1 = p0 + 5
             end
           end
-          return nil if lookingfor.size == 0
+          return "" if lookingfor.size == 0
 
           statuscode = []   # List of SMTP Status Code, Keep the order of appearances
           anotherone = ''   # Alternative code
@@ -811,10 +820,13 @@ module Sisimai
             next if characters[6] > 47 && characters[6] < 58
             statuscode << readbuffer
           end
-
           statuscode << anotherone if anotherone.size > 0
-          return nil if statuscode.size == 0
-          return statuscode.shift
+          return "" if statuscode.size == 0
+
+          # Select one from picked status codes
+          cv = statuscode.shift; statuscode.each { |e| cv = Sisimai::SMTP::Status.prefer(cv, e, "") }
+
+          return cv
         end
 
         # Return the preferred value selected from the arguments
@@ -860,11 +872,16 @@ module Sisimai
 
           return statuscode if zeroindex2['error'] > 0        # An SMTP status code is "X.0.0"
           return codeinmesg if statuscode == '4.4.7'          # "4.4.7" is an ambiguous code
+          return codeinmesg if statuscode == '4.7.0'          # "4.7.0" indicates "too many errors"
           return codeinmesg if statuscode.start_with?('5.3.') # "5.3.Z" is an error of a system
+          return codeinmesg if statuscode.end_with?('.5.1')   # "X.5.1" indicates an invalid command
+          return codeinmesg if statuscode.end_with?('.5.2')   # "X.5.2" indicates a syntax error
+          return codeinmesg if statuscode.end_with?('.5.4')   # "X.5.4" indicates an invalid command arguments
+          return codeinmesg if statuscode.end_with?('.5.5')   # "X.5.5" indicates a wrong protocol version
 
           if statuscode == '5.1.1'
             # "5.1.1" is a code of "userunknown"
-            return statuscode if zeroindex1['error'] > 0
+            return statuscode if codeinmesg.start_with?('5.5.') || zeroindex1['error'] > 0
             return codeinmesg
 
           elsif statuscode == '5.1.3'

data/lib/sisimai/smtp/transcript.rb

@@ -34,18 +34,17 @@ module Sisimai
               }
             }
           end
-          parameters = ''   # Command parameters of MAIL, RCPT
-          cursession = nil  # Current session for $esmtp
 
           cv = ''
-          p0 = argv0.index('<<<') || -1 # Server response
+          cx = nil                      # Current session for esmtp
           p1 = argv0.index('>>>') || -1 # Sent command
-          if p0 < p1
+          p2 = argv0.index('<<<') || -1 # Server response
+          if p2 < p1
             # An SMTP server response starting with '<<<' is the first
             esmtp << table.call
-            cursession = esmtp[-1]
-            cursession['command'] = 'CONN'
-            argv0 = argv0[p0, argv0.size] if p0 > -1
+            cx = esmtp[-1]
+            cx['command'] = 'CONN'
+            argv0 = argv0[p2, argv0.size] if p2 > -1
           else
             # An SMTP command starting with '>>>' is the first
             argv0 = argv0[p1, argv0.size] if p1 > -1
@@ -63,17 +62,18 @@ module Sisimai
                 # >>> SMTP Command
                 thecommand = cv[1]
                 commandarg = cv[2]
+                parameters = ''
 
                 esmtp << table.call
-                cursession = esmtp[-1]
-                cursession['command'] = thecommand.upcase
+                cx = esmtp[-1]
+                cx['command'] = thecommand.upcase
 
                 if thecommand =~ /\A(?:MAIL|RCPT|XFORWARD)/
                   # MAIL or RCPT
                   if cv = commandarg.match(/\A(?:FROM|TO):[ ]*<(.+[@].+)>[ ]*(.*)\z/)
                     # >>> MAIL FROM: <neko@example.com> SIZE=65535
                     # >>> RCPT TO: <kijitora@example.org>
-                    cursession['argument'] = cv[1]
+                    cx['argument'] = cv[1]
                     parameters = cv[2]
 
                   else
@@ -87,11 +87,11 @@ module Sisimai
 
                   parameters.split(" ").each do |p|
                     # SIZE=22022, PROTO=SMTP, and so on
-                    if cv = p.match(/\A([^ =]+)=([^ =]+)\z/) then cursession['parameter'][cv[1].downcase] = cv[2] end
+                    if cv = p.match(/\A([^ =]+)=([^ =]+)\z/) then cx['parameter'][cv[1].downcase] = cv[2] end
                   end
                 else
                   # HELO, EHLO, AUTH, DATA, QUIT or Other SMTP command
-                  cursession['argument'] = commandarg
+                  cx['argument'] = commandarg
                 end
               end
             else
@@ -101,9 +101,9 @@ module Sisimai
               e = e[4, e.size]
 
               e.sub!(/\A<<<[ ]/, '')
-              if cv = e.match(/\A([2-5]\d\d)[ ]/) then cursession['response']['reply'] = cv[1] end
-              if cv = e.match(/\A[245]\d\d[ ]([245][.]\d{1,3}[.]\d{1,3})[ ]/) then cursession['response']['status'] = cv[1] end
-              cursession['response']['text'] << e
+              if cv = e.match(/\A([2-5]\d\d)[ ]/) then cx['response']['reply'] = cv[1] end
+              if cv = e.match(/\A[245]\d\d[ ]([245][.]\d{1,3}[.]\d{1,3})[ ]/) then cx['response']['status'] = cv[1] end
+              cx['response']['text'] << e
             end
           end
 

data/lib/sisimai/string.rb

@@ -75,52 +75,6 @@ module Sisimai
         return false
       end
 
-      # Find an IPv4 address from the given string
-      # @param    [String] argv1  String including an IPv4 address
-      # @return   [Array]         List of IPv4 addresses
-      # @since v5.0.0
-      def ipv4(argv0)
-        return nil if argv0.to_s.empty?
-        return []  if argv0.size < 7
-
-        ipv4a = []
-        %w|( ) [ ]|.each do |e|
-          # Rewrite: "mx.example.jp[192.0.2.1]" => "mx.example.jp 192.0.2.1"
-          p0 = argv0.index(e); next unless p0
-          argv0[p0, 1] = ' '
-        end
-
-        argv0.split(' ').each do |e|
-          # Find string including an IPv4 address
-          next unless e.index('.')  # IPv4 address must include "." character
-
-          lx = e.size; next if lx < 7 || lx > 17  # 0.0.0.0 = 7, [255.255.255.255] = 17
-          cu = 0  # Cursor for seeking each octet of an IPv4 address
-          as = '' # ASCII Code of each character
-          eo = '' # Buffer of each octet of IPv4 Address
-
-          while cu < lx
-            # Check whether each character is a number or "." or not
-            as  = e[cu, 1].ord
-            cu += 1
-
-            if as < 48 || as > 57
-              # The character is not a number(0-9)
-              break if as      != 46  # The character is not "."
-              next  if eo      == ''  # The current buffer is empty
-              break if eo.to_i > 255  # The current buffer is greater than 255
-              eo = ''
-              next
-            end
-            eo << as.chr
-            break if eo.to_i > 255
-          end
-          ipv4a << e if eo.size > 0 && eo.to_i < 256
-        end
-
-        return ipv4a
-      end
-
       # Convert given HTML text to plain text
       # @param    [String]  argv1 HTML text
       # @param    [Boolean] loose Loose check flag

data/lib/sisimai/version.rb

@@ -1,4 +1,4 @@
 # Define the version number of Sisimai
 module Sisimai
-  VERSION = '5.1.0'.freeze
+  VERSION = '5.2.0'.freeze
 end