sisimai 4.25.15-java → 5.0.0-java

data/lib/sisimai/reason/virusdetected.rb

@@ -1,11 +1,10 @@
 module Sisimai
   module Reason
-    # Sisimai::Reason::VirusDetected checks the bounce reason is "virusdetected"
-    # or not. This class is called only Sisimai::Reason class.
+    # Sisimai::Reason::VirusDetected checks the bounce reason is "virusdetected" or not. This class
+    # is called only Sisimai::Reason class.
     #
-    # This is an error that any virus or trojan horse detected in the message by
-    # a virus scanner program at a destination mail server. This reason has been
-    # divided from "securityerror" at Sisimai 4.22.0.
+    # This is an error that any virus or trojan horse detected in the message by a virus scanner program
+    # at a destination mail server. This reason has been divided from "securityerror" at Sisimai 4.22.0.
     #
     #   Your message was infected with a virus. You should download a virus
     #   scanner and check your computer for viruses.
@@ -14,15 +13,15 @@ module Sisimai
     #     Recipient: <kijitora@example.jp>
     #
     module VirusDetected
-      # Imported from p5-Sisimail/lib/Sisimai/Reason/VirusDetected.pm
       class << self
         Index = [
           'it has a potentially executable attachment',
           'the message was rejected because it contains prohibited virus or spam content',
           'this form of attachment has been used by recent viruses or other malware',
           'virus detected',
+          'virus phishing/malicious_url detected',
           'your message was infected with a virus',
-        ]
+        ].freeze
 
         def text; return 'virusdetected'; end
         def description; return 'Email rejected due to a virus scanner on a destination host'; end
@@ -39,7 +38,7 @@ module Sisimai
         end
 
         # The bounce reason is "virusdetected" or not
-        # @param    [Sisimai::Data] argvs   Object to be detected the reason
+        # @param    [Sisimai::Fact] argvs   Object to be detected the reason
         # @return   [True,False]            true: virus detected
         #                                   false: virus was not detected
         # @since 4.22.0
@@ -48,9 +47,9 @@ module Sisimai
           # The value of "reason" isn't "visusdetected" when the value of "smtpcommand" is an SMTP
           # command to be sent before the SMTP DATA command because all the MTAs read the headers
           # and the entire message body after the DATA command.
-          return true  if argvs.reason == 'virusdetected'
-          return false if %w[CONN EHLO HELO MAIL RCPT].include?(argvs.smtpcommand)
-          return true  if match(argvs.diagnosticcode.downcase)
+          return true  if argvs['reason'] == 'virusdetected'
+          return false if %w[CONN EHLO HELO MAIL RCPT].include?(argvs['smtpcommand'])
+          return true  if match(argvs['diagnosticcode'].downcase)
           return false
         end
 

data/lib/sisimai/reason.rb

@@ -1,18 +1,16 @@
 module Sisimai
-  # Sisimai::Reason detects the bounce reason from the content of Sisimai::Data
-  # object as an argument of get() method. This class is called only Sisimai::Data
-  # class.
+  # Sisimai::Reason detects the bounce reason from the Hash table which is to be constructed to 
+  # Sisimai::Fact object as an argument of get() method. This class is called only Sisimai::Fact class.
   module Reason
-    # Imported from p5-Sisimail/lib/Sisimai/Reason.pm
     class << self
       # All the error reason list Sisimai support
       # @return   [Array] Reason list
       def index
         return %w[
-          Blocked ContentError ExceedLimit Expired Filtered HasMoved HostUnknown
-          MailboxFull MailerError MesgTooBig NetworkError NotAccept OnHold
-          Rejected NoRelaying SpamDetected VirusDetected PolicyViolation SecurityError
-          Suspend SystemError SystemFull TooManyConn UserUnknown SyntaxError
+          AuthFailure BadReputation Blocked ContentError ExceedLimit Expired Filtered HasMoved
+          HostUnknown MailboxFull MailerError MesgTooBig NetworkError NotAccept NotCompliantRFC
+          OnHold Rejected NoRelaying Speeding SpamDetected VirusDetected PolicyViolation 
+          SecurityError Suspend RequirePTR SystemError SystemFull TooManyConn UserUnknown SyntaxError
         ]
       end
 
@@ -27,55 +25,57 @@ module Sisimai
       end
 
       # Reason list better to retry detecting an error reason
-      # @return   [Array] Reason list
+      # @return   [Hash] Reason list
       def retry
         return {
-          'undefined' => 1, 'onhold' => 1, 'systemerror' => 1, 'securityerror' => 1,
-          'networkerror' => 1, 'hostunknown' => 1, 'userunknown' => 1
+          'undefined' => true, 'onhold' => true, 'systemerror' => true, 'securityerror' => true,
+          'expired' => true, 'suspend' => true, 'networkerror' => true, 'hostunknown' => true,
+          'userunknown' => true
         }.freeze
       end
       ModulePath = Sisimai::Reason.path
       GetRetried = Sisimai::Reason.retry
       ClassOrder = [
         %w[
-          MailboxFull MesgTooBig ExceedLimit Suspend HasMoved NoRelaying UserUnknown
-          Filtered Rejected HostUnknown SpamDetected TooManyConn Blocked
+          MailboxFull MesgTooBig ExceedLimit Suspend HasMoved NoRelaying AuthFailure UserUnknown
+          Filtered RequirePTR NotCompliantRFC Rejected HostUnknown SpamDetected Speeding TooManyConn
+          Blocked
         ],
         %w[
-          MailboxFull SpamDetected PolicyViolation VirusDetected NoRelaying
-          SecurityError SystemError NetworkError Suspend Expired ContentError
+          MailboxFull SpamDetected PolicyViolation VirusDetected NoRelaying AuthFailure
+          BadReputation SecurityError SystemError NetworkError Speeding Suspend Expired ContentError
           SystemFull NotAccept MailerError
         ],
         %w[
-          MailboxFull MesgTooBig ExceedLimit Suspend UserUnknown Filtered Rejected
-          HostUnknown SpamDetected TooManyConn Blocked SpamDetected SecurityError
-          SystemError NetworkError Suspend Expired ContentError HasMoved SystemFull
-          NotAccept MailerError NoRelaying SyntaxError OnHold
+          MailboxFull MesgTooBig ExceedLimit Suspend UserUnknown Filtered Rejected HostUnknown
+          SpamDetected Speeding TooManyConn Blocked SpamDetected AuthFailure SecurityError
+          SystemError NetworkError Suspend Expired ContentError HasMoved SystemFull NotAccept
+          MailerError NoRelaying SyntaxError OnHold
         ]
       ]
 
       # Detect the bounce reason
-      # @param    [Sisimai::Data] argvs   Parsed email object
-      # @return   [String, Nil]           Bounce reason or Nil if the argument
-      #                                   is missing or invalid object
+      # @param    [Hash] argvs  Parsed email object
+      # @return   [String, nil] Bounce reason or nil if the argument is missing or not Hash
       # @see anotherone
       def get(argvs)
         return nil unless argvs
-        return nil unless argvs.is_a? Sisimai::Data
-
-        unless GetRetried[argvs.reason]
-          # Return reason text already decided except reason match with the
-          # regular expression of retry() method.
-          return argvs.reason unless argvs.reason.empty?
+        unless GetRetried[argvs['reason']]
+          # Return reason text already decided except reason match with the regular expression of
+          # retry() method.
+          return argvs['reason'] unless argvs['reason'].empty?
         end
-        return 'delivered' if argvs.deliverystatus.start_with?('2.')
+        return 'delivered' if argvs['deliverystatus'].start_with?('2.')
 
         reasontext = ''
-        if argvs.diagnostictype == 'SMTP' || argvs.diagnostictype == ''
+        issuedcode = argvs['diagnosticcode'] || ''
+        codeformat = argvs['diagnostictype'] || ''
+
+        if codeformat == 'SMTP' || codeformat == ''
           # Diagnostic-Code: SMTP; ... or empty value
           ClassOrder[0].each do |e|
-            # Check the value of Diagnostic-Code: and the value of Status:, it is a
-            # deliverystats, with true() method in each Sisimai::Reason::* class.
+            # Check the value of Diagnostic-Code: and the value of Status:, it is a deliverystats,
+            # with true() method in each Sisimai::Reason::* class.
             p = 'Sisimai::Reason::' << e
             r = nil
             begin
@@ -98,13 +98,13 @@ module Sisimai
           if reasontext == 'undefined' || reasontext.empty?
             # Action: delayed => "expired"
             reasontext   = nil
-            reasontext ||= 'expired' if argvs.action == 'delayed'
+            reasontext ||= 'expired' if argvs['action'] == 'delayed'
             return reasontext if reasontext
 
             # Try to match with message patterns in Sisimai::Reason::Vacation
             require 'sisimai/reason/vacation'
-            reasontext   = 'vacation' if Sisimai::Reason::Vacation.match(argvs.diagnosticcode.downcase)
-            reasontext ||= 'onhold'   unless argvs.diagnosticcode.empty?
+            reasontext   = 'vacation' if Sisimai::Reason::Vacation.match(issuedcode.downcase)
+            reasontext ||= 'onhold'   unless issuedcode.empty?
             reasontext ||= 'undefined'
           end
         end
@@ -112,24 +112,24 @@ module Sisimai
       end
 
       # Detect the other bounce reason, fall back method for get()
-      # @param    [Sisimai::Data] argvs   Parsed email object
-      # @return   [String, Nil]           Bounce reason or nli if the argument
-      #                                   is missing or invalid object
+      # @param    [Hash] argvs  Parsed email object
+      # @return   [String, Nil] Bounce reason or nli if the argument is missing or not Hash
       # @see get
       def anotherone(argvs)
-        return nil unless argvs.is_a? Sisimai::Data
-        return argvs.reason unless argvs.reason.empty?
+        return argvs['reason'] unless argvs['reason'].empty?
 
         require 'sisimai/smtp/status'
-        statuscode = argvs.deliverystatus || ''
+        issuedcode = argvs['diagnosticcode'].downcase || ''
+        codeformat = argvs['diagnostictype']          || ''
+        actiontext = argvs['action']                  || ''
+        statuscode = argvs['deliverystatus']          || ''
         reasontext = Sisimai::SMTP::Status.name(statuscode) || ''
 
         catch :TRY_TO_MATCH do
           while true
-            diagnostic   = argvs.diagnosticcode.downcase || ''
             trytomatch   = reasontext.empty? ? true : false
             trytomatch ||= true if GetRetried[reasontext]
-            trytomatch ||= true if argvs.diagnostictype != 'SMTP'
+            trytomatch ||= true if codeformat != 'SMTP'
             throw :TRY_TO_MATCH unless trytomatch
 
             # Could not decide the reason by the value of Status:
@@ -145,25 +145,26 @@ module Sisimai
                 next
               end
 
-              next unless r.match(diagnostic)
+              next unless r.match(issuedcode)
               reasontext = e.downcase
               break
             end
             throw :TRY_TO_MATCH unless reasontext.empty?
 
             # Check the value of Status:
-            v = statuscode[0, 3]
-            if v == '5.6' || v == '4.6'
+            code2digit = statuscode[0, 3] || ''
+            if code2digit == '5.6' || code2digit == '4.6'
               #  X.6.0   Other or undefined media error
               reasontext = 'contenterror'
 
-            elsif v == '5.7' || v == '4.7'
+            elsif code2digit == '5.7' || code2digit == '4.7'
               #  X.7.0   Other or undefined security status
               reasontext = 'securityerror'
 
-            elsif %w[X-UNIX X-POSTFIX].include?(argvs.diagnostictype)
+            elsif codeformat.start_with?('X-UNIX')
               # Diagnostic-Code: X-UNIX; ...
               reasontext = 'mailererror'
+
             else
               # 50X Syntax Error?
               require 'sisimai/reason/syntaxerror'
@@ -172,13 +173,13 @@ module Sisimai
             throw :TRY_TO_MATCH unless reasontext.empty?
 
             # Check the value of Action: field, first
-            if argvs.action.start_with?('delayed', 'expired')
+            if actiontext.start_with?('delayed', 'expired')
               # Action: delayed, expired
               reasontext = 'expired'
             else
               # Rejected at connection or after EHLO|HELO
-              commandtxt = argvs.smtpcommand || ''
-              reasontext = 'blocked' if %w[HELO EHLO].index(commandtxt)
+              thecommand = argvs['smtpcommand'] || ''
+              reasontext = 'blocked' if %w[HELO EHLO].index(thecommand)
             end
             throw :TRY_TO_MATCH
           end
@@ -193,12 +194,12 @@ module Sisimai
         return nil unless argv1
 
         reasontext = ''
-        diagnostic = argv1.downcase
+        issuedcode = argv1.downcase
 
         # Diagnostic-Code: SMTP; ... or empty value
         ClassOrder[2].each do |e|
-          # Check the value of Diagnostic-Code: and the value of Status:, it is a
-          # deliverystats, with true() method in each Sisimai::Reason::* class.
+          # Check the value of Diagnostic-Code: and the value of Status:, it is a deliverystats, with
+          # true() method in each Sisimai::Reason::* class.
           p = 'Sisimai::Reason::' << e
           r = nil
           begin
@@ -209,26 +210,20 @@ module Sisimai
             next
           end
 
-          next unless r.match(diagnostic)
+          next unless r.match(issuedcode)
           reasontext = r.text
           break
         end
         return reasontext unless reasontext.empty?
 
-        typestring = ''
-        if cv = argv1.match(/\A(SMTP|X-.+);/i)
-          # Check the value of typestring
-          typestring = cv[1].upcase
-        end
-
-        if typestring == 'X-UNIX'
+        if issuedcode.upcase == 'X-UNIX'
           # X-Unix; ...
           reasontext = 'mailererror'
         else
           # Detect the bounce reason from "Status:" code
           require 'sisimai/smtp/status'
-          statuscode = Sisimai::SMTP::Status.find(argv1) || ''
-          reasontext = Sisimai::SMTP::Status.name(statuscode) || 'undefined'
+          cv = Sisimai::SMTP::Status.find(argv1)      || ''
+          reasontext = Sisimai::SMTP::Status.name(cv) || 'undefined'
         end
         return reasontext
       end

data/lib/sisimai/rfc1894.rb

@@ -1,14 +1,13 @@
 module Sisimai
   # Sisimai::RFC1894 DSN field defined in RFC3464 (obsoletes RFC1894)
   module RFC1894
-    # Imported from p5-Sisimail/lib/Sisimai/RFC1894.pm
     class << self
-      FieldNames = [
+      FieldNames = {
         # https://tools.ietf.org/html/rfc3464#section-2.2
-        #   Some fields of a DSN apply to all of the delivery attempts described by
-        #   that DSN. At most, these fields may appear once in any DSN. These fields
-        #   are used to correlate the DSN with the original message transaction and
-        #   to provide additional information which may be useful to gateways.
+        #   Some fields of a DSN apply to all of the delivery attempts described by that DSN. At
+        #   most, these fields may appear once in any DSN. These fields are used to correlate the
+        #   DSN with the original message transaction and to provide additional information which
+        #   may be useful to gateways.
         #
         #   The following fields (not defined in RFC 3464) are used in Sisimai
         #     - X-Original-Message-ID: <....> (GSuite)
@@ -16,13 +15,16 @@ module Sisimai
         #   The following fields are not used in Sisimai:
         #     - Original-Envelope-Id
         #     - DSN-Gateway
-        %w[Reporting-MTA Received-From-MTA Arrival-Date X-Original-Message-ID],
+        'arrival-date'          => ':',
+        'received-from-mta'     => ';',
+        'reporting-mta'         => ';',
+        'x-original-message-id' => '@',
 
         # https://tools.ietf.org/html/rfc3464#section-2.3
-        #   A DSN contains information about attempts to deliver a message to one or
-        #   more recipients. The delivery information for any particular recipient is
-        #   contained in a group of contiguous per-recipient fields.
-        #   Each group of per-recipient fields is preceded by a blank line.
+        #   A DSN contains information about attempts to deliver a message to one or more recipi-
+        #   ents. The delivery information for any particular recipient is contained in a group of
+        #   contiguous per-recipient fields. Each group of per-recipient fields is preceded by a
+        #   blank line.
         #
         #   The following fields (not defined in RFC 3464) are used in Sisimai
         #     - X-Actual-Recipient: RFC822; ....
@@ -30,18 +32,24 @@ module Sisimai
         #   The following fields are not used in Sisimai:
         #     - Will-Retry-Until
         #     - Final-Log-ID
-        %w[Original-Recipient Final-Recipient Action Status Remote-MTA
-            Diagnostic-Code Last-Attempt-Date X-Actual-Recipient],
-      ].freeze
+        'action'                => 'e',
+        'diagnostic-code'       => ';',
+        'final-recipient'       => ';',
+        'last-attempt-date'     => ':',
+        'original-recipient'    => ';',
+        'remote-mta'            => ';',
+        'status'                => '.',
+        'x-actual-recipient'    => ';',
+      }.freeze
 
       CapturesOn = {
-        'addr' => %r/\A((?:Original|Final|X-Actual)-Recipient):[ ]*(.+?);[ ]*(.+)/,
-        'code' => %r/\A(Diagnostic-Code):[ ]*(.+?);[ ]*(.*)/,
-        'date' => %r/\A((?:Arrival|Last-Attempt)-Date):[ ]*(.+)/,
-        'host' => %r/\A((?:Received-From|Remote|Reporting)-MTA):[ ]*(.+?);[ ]*(.+)/,
-        'list' => %r/\A(Action):[ ]*(delayed|deliverable|delivered|expanded|expired|failed|failure|relayed)/i,
-        'stat' => %r/\A(Status):[ ]*([245][.]\d+[.]\d+)/,
-        'text' => %r/\A(X-Original-Message-ID):[ ]*(.+)/,
+        'addr' => %r/\A((?:Original|Final|X-Actual)-Recipient):[ ](.+?);[ ]*(.+)/,
+        'code' => %r/\A(Diagnostic-Code):[ ](.+?);[ ]*(.*)/,
+        'date' => %r/\A((?:Arrival|Last-Attempt)-Date):[ ](.+)/,
+        'host' => %r/\A((?:Received-From|Remote|Reporting)-MTA):[ ](.+?);[ ]*(.+)/,
+        'list' => %r/\A(Action):[ ](delayed|deliverable|delivered|expanded|expired|failed|failure|relayed)/i,
+        'stat' => %r/\A(Status):[ ]([245][.]\d+[.]\d+)/,
+        'text' => %r/\A(X-Original-Message-ID):[ ](.+)/,
        #'text' => %r/\A(Final-Log-ID|Original-Envelope-Id):[ ]*(.+)/,
       }.freeze
 
@@ -61,6 +69,13 @@ module Sisimai
         'x-original-message-id' => 'text',
       }.freeze
 
+      def FIELDINDEX
+        return %w[
+            Action Arrival-Date Diagnostic-Code Final-Recipient Last-Attempt-Date Original-Recipient
+            Received-From-MTA Remote-MTA Reporting-MTA Status X-Actual-Recipienet X-Original-Message-ID
+        ]
+      end
+
       # Table to be converted to key name defined in Sisimai::Lhost class
       # @param    [Symbol] group  RFC822 Header group name
       # @return   [Array,Hash]    RFC822 Header list
@@ -81,23 +96,35 @@ module Sisimai
       end
 
       # Check the argument matches with a field defined in RFC3464
-      # @param    [String] argv0 A line inlcuding field and value defined in RFC3464
-      # @return   [Integer]      0: did not matched, 1,2: matched
+      # @param    [String] argv0 A line including field and value defined in RFC3464
+      # @return   [Boolean]      false: did not matched, true: matched
       # @since v4.25.0
       def match(argv0 = '')
+        label = Sisimai::RFC1894.label(argv0)
+
+        return false unless label
+        return false unless FieldNames.has_key?(label)
+        return false unless argv0.include?(FieldNames[label])
+        return true
+      end
+
+      # Returns a field name as a lqbel from the given string
+      # @param    [String] argv0 A line including field and value defined in RFC3464
+      # @return   [String]       Field name as a label
+      # @since v4.25.15
+      def label(argv0 = '')
         return nil if argv0.empty?
-        return 1   if FieldNames[0].any? { |a| argv0.start_with?(a) }
-        return 2   if FieldNames[1].any? { |a| argv0.start_with?(a) }
-        return nil
+        return argv0.split(':', 2).shift.downcase
       end
 
       # Check the argument is including field defined in RFC3464 and return values
-      # @param    [String] argv0 A line inlcuding field and value defined in RFC3464
+      # @param    [String] argv0 A line including field and value defined in RFC3464
       # @return   [Array]        ['field-name', 'value-type', 'Value', 'field-group']
       # @since v4.25.0
       def field(argv0 = '')
         return nil if argv0.empty?
-        group = FieldGroup[argv0.split(':',2).shift.downcase] || ''
+        label = Sisimai::RFC1894.label(argv0)
+        group = FieldGroup[label] || ''
 
         return nil if group.empty?
         return nil unless CapturesOn[group]