sisimai 4.24.1 → 4.25.0

data/lib/sisimai/reason/vacation.rb

@@ -5,6 +5,13 @@ module Sisimai
     module Vacation
       # Imported from p5-Sisimail/lib/Sisimai/Reason/Vacation.pm
       class << self
+        Index = [
+          'i am away on vacation',
+          'i am away until',
+          'i am out of the office',
+          'i will be traveling for work on',
+        ]
+
         def text; return 'vacation'; end
         def description; return 'Email replied automatically due to a recipient is out of office'; end
 
@@ -14,14 +21,7 @@ module Sisimai
         #                           true: Matched
         def match(argv1)
           return nil unless argv1
-          index = [
-            'i am away on vacation',
-            'i am away until',
-            'i am out of the office',
-            'i will be traveling for work on',
-          ]
-
-          return true if index.any? { |a| argv1.include?(a) }
+          return true if Index.any? { |a| argv1.include?(a) }
           return false
         end
 

data/lib/sisimai/reason/virusdetected.rb

@@ -16,6 +16,13 @@ module Sisimai
     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',
+          'your message was infected with a virus',
+        ]
+
         def text; return 'virusdetected'; end
         def description; return 'Email rejected due to a virus scanner on a destination host'; end
 
@@ -26,14 +33,7 @@ module Sisimai
         # @since 4.22.0
         def match(argv1)
           return nil unless argv1
-          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',
-            'your message was infected with a virus',
-          ]
-
-          return true if index.any? { |a| argv1.include?(a) }
+          return true if Index.any? { |a| argv1.include?(a) }
           return false
         end
 

data/lib/sisimai/rfc1894.rb

@@ -0,0 +1,142 @@
+module Sisimai
+  # Sisimai::RFC1894 DSN field defined in RFC3464 (obsoletes RFC1894)
+  module RFC1894
+    # Imported from p5-Sisimail/lib/Sisimai/RFC1894.pm
+    class << self
+      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.
+        #
+        #   The following fields (not defined in RFC 3464) are used in Sisimai
+        #     - X-Original-Message-ID: <....> (GSuite)
+        #
+        #   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],
+
+        # 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.
+        #
+        #   The following fields (not defined in RFC 3464) are used in Sisimai
+        #     - X-Actual-Recipient: RFC822; ....
+        #
+        #   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
+
+      CapturesOn = {
+        'addr' => %r/\A((?:Original|Final|X-Actual)-Recipient):[ ]*(.+?);[ ]*(.+)/,
+        'code' => %r/\A(Diagnostic-Code):[ ]*(.+?);[ ]*(.*)/,
+        'date' => %r/\A((?:Arrival|Last-Attempt)-Date):[ ]*(.+)/,
+        'host' => %r/\A((?:Reporting|Received-From|Remote)-MTA):[ ]*(.+?);[ ]*(.+)/,
+        'list' => %r/\A(Action):[ ]*(failed|delayed|delivered|relayed|expanded|expired|failure)/i,
+        'stat' => %r/\A(Status):[ ]*([245][.]\d+[.]\d+)/,
+        'text' => %r/\A(X-Original-Message-ID):[ ]*(.+)/,
+       #text: %r/\A(Original-Envelope-Id|Final-Log-ID):[ ]*(.+)/,
+      }.freeze
+
+      Correction = { action: { 'failure' => 'failed', 'expired' => 'delayed' } }
+      FieldGroup = {
+        'original-recipient'    => 'addr',
+        'final-recipient'       => 'addr',
+        'x-actual-recipient'    => 'addr',
+        'diagnostic-code'       => 'code',
+        'arrival-date'          => 'date',
+        'last-attempt-date'     => 'date',
+        'received-from-mta'     => 'host',
+        'remote-mta'            => 'host',
+        'reporting-mta'         => 'host',
+        'action'                => 'list',
+        'status'                => 'stat',
+        'x-original-message-id' => 'text',
+      }.freeze
+
+      # Table to be converted to key name defined in Sisimai::Bite class
+      # @param    [Symbol] group  RFC822 Header group name
+      # @return   [Array,Hash]    RFC822 Header list
+      def FIELDTABLE
+        return {
+          'action'             => 'action',
+          'arrival-date'       => 'date',
+          'diagnostic-code'    => 'diagnosis',
+          'final-recipient'    => 'recipient',
+          'last-attempt-date'  => 'date',
+          'original-recipient' => 'alias',
+          'received-from-mta'  => 'lhost',
+          'remote-mta'         => 'rhost',
+          'reporting-mta'      => 'rhost',
+          'status'             => 'status',
+          'x-actual-recipient' => 'alias',
+        }
+      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
+      # @since v4.25.0
+      def match(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
+      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
+      # @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] || ''
+        match = []
+
+        return nil if group.empty?
+        return nil unless CapturesOn[group]
+
+        while cv = argv0.match(CapturesOn[group])
+          # Try to match with each pattern of Per-Message field, Per-Recipient field
+          # - 0: Field-Name
+          # - 1: Sub Type: RFC822, DNS, X-Unix, and so on)
+          # - 2: Value
+          # - 3: Field Group(addr, code, date, host, stat, text)
+          match[0] = cv[1].downcase
+          match[3] = group
+
+          if group == 'addr' || group == 'code' || group == 'host'
+            # - Final-Recipient: RFC822; kijitora@nyaan.jp
+            # - Diagnostic-Code: SMTP; 550 5.1.1 <kijitora@example.jp>... User Unknown
+            # - Remote-MTA: DNS; mx.example.jp
+            match[1] = cv[2].upcase
+            match[2] = group == 'host' ? cv[3].downcase : cv[3]
+            match[2] = '' if match[2] =~ /\A\s+\z/  # Remote-MTA: dns; 
+          else
+            # - Action: failed
+            # - Status: 5.2.2
+            match[1] = ''
+            match[2] = group == 'date' ? cv[2] : cv[2].downcase
+
+            # Correct invalid value in Action field:
+            break unless group == 'list'
+            break unless Correction[:action].key?(match[2])
+            match[2] = Correction[:action][match[2]]
+          end
+          break
+        end
+        return nil if match.empty?
+        return match
+      end
+
+    end
+  end
+end
+

data/lib/sisimai/rfc3464.rb

@@ -27,6 +27,68 @@ module Sisimai
         error:   %r/\A(?:[45]\d\d[ \t]+|[<][^@]+[@][^@]+[>]:?[ \t]+)/,
         command: %r/[ ](RCPT|MAIL|DATA)[ ]+command\b/,
       }.freeze
+      ReSkip = %r{(?>
+         \A[-]+=
+        |\A\s+\z
+        |\A\s*--
+        |\A\s+[=]\d+
+        |\Ahi[ ][!]
+        |content-(?:description|disposition|transfer-encoding|type):[ ]
+        |(?:name|charset)=
+        |--\z
+        |:[ ]--------
+        )
+      }x.freeze
+      ReStop = %r{(?:
+         \A[*][*][*][ ].+[ ].+[ ][*][*][*]
+        |\Acontent-type:[ ]message/delivery-status
+        |\Ahere[ ]is[ ]a[ ]copy[ ]of[ ]the[ ]first[ ]part[ ]of[ ]the[ ]message
+        |\Athe[ ]non-delivered[ ]message[ ]is[ ]attached[ ]to[ ]this[ ]message.
+        |\Areceived:[ \t]*
+        |\Areceived-from-mta:[ \t]*
+        |\Areporting-mta:[ \t]*
+        |\Areturn-path:[ \t]*
+        |\Aa[ ]copy[ ]of[ ]the[ ]original[ ]message[ ]below[ ]this[ ]line:
+        |attachment[ ]is[ ]a[ ]copy[ ]of[ ]the[ ]message
+        |below[ ]is[ ]a[ ]copy[ ]of[ ]the[ ]original[ ]message:
+        |below[ ]this[ ]line[ ]is[ ]a[ ]copy[ ]of[ ]the[ ]message
+        |message[ ]contains[ ].+[ ]file[ ]attachments
+        |message[ ]text[ ]follows:[ ]
+        |original[ ]message[ ]follows
+        |the[ ]attachment[ ]contains[ ]the[ ]original[ ]mail[ ]headers
+        |the[ ]first[ ]\d+[ ]lines[ ]
+        |unsent[ ]Message[ ]below
+        |your[ ]message[ ]reads[ ][(]in[ ]part[)]:
+        )
+      }x.freeze
+      ReAddr = %r{(?:
+         \A\s*
+        |\A["].+["]\s*
+        |\A[ \t]*Recipient:[ \t]*
+        |\A[ ]*Address:[ ]
+        |addressed[ ]to[ ]
+        |Could[ ]not[ ]be[ ]delivered[ ]to:[ ]
+        |delivered[ ]to[ ]+
+        |delivery[ ]failed:[ ]
+        |Did[ ]not[ ]reach[ ]the[ ]following[ ]recipient:[ ]
+        |Error-for:[ ]+
+        |Failed[ ]Recipient:[ ]
+        |Failed[ ]to[ ]deliver[ ]to[ ]
+        |Intended[ ]recipient:[ ]
+        |Mailbox[ ]is[ ]full:[ ]
+        |RCPT[ ]To:
+        |SMTP[ ]Server[ ][<].+[>][ ]rejected[ ]recipient[ ]
+        |The[ ]following[ ]recipients[ ]returned[ ]permanent[ ]errors:[ ]
+        |The[ ]following[ ]message[ ]to[ ]
+        |Unknown[ ]User:[ ]
+        |undeliverable[ ]to[ ]
+        |Undeliverable[ ]Address:[ ]*
+        |You[ ]sent[ ]mail[ ]to[ ]
+        |Your[ ]message[ ]to[ ]
+        )
+        ['"]?[<]?([^\s\n\r@=<>]+[@][-.0-9A-Za-z]+[.][0-9A-Za-z]+)[>]?['"]?
+      }xi.freeze
+
 
       def description; 'Fallback Module for MTAs'; end
       def smtpagent;   'RFC3464'; end
@@ -84,7 +146,7 @@ module Sisimai
           end
 
           if readcursor & Indicators[:'message-rfc822'] > 0
-            # After "message/rfc822"
+            # Inside of the original message part
             if e.empty?
               blanklines += 1
               break if blanklines > 1
@@ -92,13 +154,13 @@ module Sisimai
             end
             rfc822list << e
           else
-            # Before "message/rfc822"
+            # Error message part
             next unless readcursor & Indicators[:deliverystatus] > 0
             next if e.empty?
 
             v = dscontents[-1]
-            if cv = e.match(/\A(?:Final|Original)-Recipient:[ ]*(?:RFC|rfc)822;[ ]*([^ ]+)\z/) ||
-                    e.match(/\A(?:Final|Original)-Recipient:[ ]*([^ ]+)\z/)
+            if cv = e.match(/\A(?:Final|Original)-[Rr]ecipient:[ ]*(?:RFC|rfc)822;[ ]*([^ ]+)\z/) ||
+                    e.match(/\A(?:Final|Original)-[Rr]ecipient:[ ]*([^ ]+)\z/)
               # 2.3.2 Final-Recipient field
               #   The Final-Recipient field indicates the recipient for which this set
               #   of per-recipient fields applies.  This field MUST be present in each
@@ -305,68 +367,6 @@ module Sisimai
           end
           break unless match > 0
 
-          re_skip = %r{(?>
-             \A[-]+=
-            |\A\s+\z
-            |\A\s*--
-            |\A\s+[=]\d+
-            |\Ahi[ ][!]
-            |content-(?:description|disposition|transfer-encoding|type):[ ]
-            |(?:name|charset)=
-            |--\z
-            |:[ ]--------
-            )
-          }x
-          re_stop = %r{(?:
-             \A[*][*][*][ ].+[ ].+[ ][*][*][*]
-            |\Acontent-type:[ ]message/delivery-status
-            |\Ahere[ ]is[ ]a[ ]copy[ ]of[ ]the[ ]first[ ]part[ ]of[ ]the[ ]message
-            |\Athe[ ]non-delivered[ ]message[ ]is[ ]attached[ ]to[ ]this[ ]message.
-            |\Areceived:[ \t]*
-            |\Areceived-from-mta:[ \t]*
-            |\Areporting-mta:[ \t]*
-            |\Areturn-path:[ \t]*
-            |\Aa[ ]copy[ ]of[ ]the[ ]original[ ]message[ ]below[ ]this[ ]line:
-            |attachment[ ]is[ ]a[ ]copy[ ]of[ ]the[ ]message
-            |below[ ]is[ ]a[ ]copy[ ]of[ ]the[ ]original[ ]message:
-            |below[ ]this[ ]line[ ]is[ ]a[ ]copy[ ]of[ ]the[ ]message
-            |message[ ]contains[ ].+[ ]file[ ]attachments
-            |message[ ]text[ ]follows:[ ]
-            |original[ ]message[ ]follows
-            |the[ ]attachment[ ]contains[ ]the[ ]original[ ]mail[ ]headers
-            |the[ ]first[ ]\d+[ ]lines[ ]
-            |unsent[ ]Message[ ]below
-            |your[ ]message[ ]reads[ ][(]in[ ]part[)]:
-            )
-          }x
-          re_addr = %r{(?:
-             \A\s*
-            |\A["].+["]\s*
-            |\A[ \t]*Recipient:[ \t]*
-            |\A[ ]*Address:[ ]
-            |addressed[ ]to[ ]
-            |Could[ ]not[ ]be[ ]delivered[ ]to:[ ]
-            |delivered[ ]to[ ]+
-            |delivery[ ]failed:[ ]
-            |Did[ ]not[ ]reach[ ]the[ ]following[ ]recipient:[ ]
-            |Error-for:[ ]+
-            |Failed[ ]Recipient:[ ]
-            |Failed[ ]to[ ]deliver[ ]to[ ]
-            |Intended[ ]recipient:[ ]
-            |Mailbox[ ]is[ ]full:[ ]
-            |RCPT[ ]To:
-            |SMTP[ ]Server[ ][<].+[>][ ]rejected[ ]recipient[ ]
-            |The[ ]following[ ]recipients[ ]returned[ ]permanent[ ]errors:[ ]
-            |The[ ]following[ ]message[ ]to[ ]
-            |Unknown[ ]User:[ ]
-            |undeliverable[ ]to[ ]
-            |Undeliverable[ ]Address:[ ]*
-            |You[ ]sent[ ]mail[ ]to[ ]
-            |Your[ ]message[ ]to[ ]
-            )
-            ['"]?[<]?([^\s\n\r@=<>]+[@][-.0-9A-Za-z]+[.][0-9A-Za-z]+)[>]?['"]?
-          }xi
-
           b = dscontents[-1]
           hasdivided = mbody.split("\n")
           while e = hasdivided.shift do
@@ -374,13 +374,13 @@ module Sisimai
             break if e.start_with?('__END_OF_EMAIL_MESSAGE__')
             d = e.downcase
             break if d =~ MarkingsOf[:rfc822]
-            break if d =~ re_stop
+            break if d =~ ReStop
 
             next if e.empty?
-            next if d =~ re_skip
+            next if d =~ ReSkip
             next if e.start_with?('*')
 
-            if cv = e.match(re_addr)
+            if cv = e.match(ReAddr)
               # May be an email address
               x = b['recipient'] || ''
               y = Sisimai::Address.s3s4(cv[1])
@@ -451,7 +451,7 @@ module Sisimai
             e['agent'] = self.smtpagent
           end
 
-          e['status'] ||= Sisimai::SMTP::Status.find(e['diagnosis'])
+          e['status'] ||= Sisimai::SMTP::Status.find(e['diagnosis']) || ''
           if cv = e['diagnosis'].match(MarkingsOf[:command])
             e['command'] = cv[1]
           end

data/lib/sisimai/rfc3834.rb

@@ -7,11 +7,11 @@ module Sisimai
       MarkingsOf = { :boundary => %r/\A__SISIMAI_PSEUDO_BOUNDARY__\z/ }
       AutoReply1 = {
         # http://www.iana.org/assignments/auto-submitted-keywords/auto-submitted-keywords.xhtml
-        :'auto-submitted' => %r/\Aauto-(?:generated|replied|notified)/,
+        'auto-submitted' => %r/\Aauto-(?:generated|replied|notified)/,
         # https://msdn.microsoft.com/en-us/library/ee219609(v=exchg.80).aspx
-        :'x-auto-response-suppress' => %r/(?:oof|autoreply)/,
-        :'precedence' => %r/\Aauto_reply\z/,
-        :'subject' => %r/\A(?>
+        'x-auto-response-suppress' => %r/(?:oof|autoreply)/,
+        'precedence' => %r/\Aauto_reply\z/,
+        'subject' => %r/\A(?>
              auto:
             |auto[ ]response:
             |automatic[ ]reply:
@@ -20,13 +20,13 @@ module Sisimai
         /x,
       }.freeze
       Excludings = {
-        :subject => %r/(?:
+        'subject' => %r/(?:
              security[ ]information[ ]for  # sudo
             |mail[ ]failure[ ][-]          # Exim
             )
         /x,
-        :from    => %r/(?:root|postmaster|mailer-daemon)[@]/,
-        :to      => %r/root[@]/,
+        'from' => %r/(?:root|postmaster|mailer-daemon)[@]/,
+        'to'   => %r/root[@]/,
       }.freeze
       SubjectSet = %r{\A(?>
          (?:.+?)?Re:
@@ -35,11 +35,11 @@ module Sisimai
         |Out[ ]of[ ]Office:
         )
         [ ]*(.+)\z
-      }xi
+      }xi.freeze
 
       def description; 'Detector for auto replied message'; end
       def smtpagent;   'RFC3834'; end
-      def headerlist;  return %w[Auto-Submitted Precedence X-Auto-Response-Suppress]; end
+      def headerlist;  return %w[auto-submitted precedence x-auto-response-suppress]; end
 
       # Detect auto reply message as RFC3834
       # @param         [Hash] mhead       Message header of a bounce email
@@ -59,9 +59,9 @@ module Sisimai
         # DETECT_EXCLUSION_MESSAGE
         Excludings.each_key do |e|
           # Exclude message from root@
-          next unless mhead.key?(e.to_s)
-          next unless mhead[e.to_s]
-          next unless mhead[e.to_s].downcase =~ Excludings[e]
+          next unless mhead.key?(e)
+          next unless mhead[e]
+          next unless mhead[e].downcase =~ Excludings[e]
           leave = 1
           break
         end
@@ -70,9 +70,9 @@ module Sisimai
         # DETECT_AUTO_REPLY_MESSAGE
         AutoReply1.each_key do |e|
           # RFC3834 Auto-Submitted and other headers
-          next unless mhead.key?(e.to_s)
-          next unless mhead[e.to_s]
-          next unless mhead[e.to_s].downcase =~ AutoReply1[e]
+          next unless mhead.key?(e)
+          next unless mhead[e]
+          next unless mhead[e].downcase =~ AutoReply1[e]
           match += 1
           break
         end