sisimai 4.21.1-java → 4.22.0-java

data/lib/sisimai/arf.rb

@@ -1,9 +1,9 @@
 module Sisimai
   # Sisimai::ARF is a parser for email returned as a FeedBack Loop report message.
   module ARF
-    # Imported from p5-Sisimail/lib/Sisimai/Message.pm
+    # Imported from p5-Sisimail/lib/Sisimai/ARF.pm
     class << self
-      require 'sisimai/mta'
+      require 'sisimai/bite/email'
       require 'sisimai/rfc5322'
 
       Re0 =  {
@@ -36,7 +36,7 @@ module Sisimai
         :rfc822 => %r[\AContent-Type: (:?message/rfc822|text/rfc822-headers)],
         :endof  => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
       }
-      Indicators = Sisimai::MTA.INDICATORS
+      Indicators = Sisimai::Bite::Email.INDICATORS
       LongFields = Sisimai::RFC5322.LONGFIELDS
       RFC822Head = Sisimai::RFC5322.HEADERFIELDS
 
@@ -72,7 +72,7 @@ module Sisimai
       end
 
       # Detect an error for Feedback Loop
-      # @param         [Hash] mhead       Message header of a bounce email
+      # @param         [Hash] mhead       Message headers of a bounce email
       # @options mhead [String] from      From header
       # @options mhead [String] date      Date header
       # @options mhead [String] subject   Subject header
@@ -86,7 +86,7 @@ module Sisimai
         return nil unless self.is_arf(mhead)
 
         require 'sisimai/address'
-        dscontents = [Sisimai::MTA.DELIVERYSTATUS]
+        dscontents = [Sisimai::Bite.DELIVERYSTATUS]
         hasdivided = mbody.split("\n")
         rfc822part = ''   # (String) message/rfc822-headers part
         previousfn = ''   # (String) Previous field name
@@ -204,7 +204,7 @@ module Sisimai
               # Redacted-Address: localpart@
               if v['recipient']
                 # There are multiple recipient addresses in the message body.
-                dscontents << Sisimai::MTA.DELIVERYSTATUS
+                dscontents << Sisimai::Bite.DELIVERYSTATUS
                 v = dscontents[-1]
               end
               v['recipient'] = Sisimai::Address.s3s4(cv[1])

data/lib/sisimai/bite.rb

@@ -0,0 +1,37 @@
+module Sisimai
+  # Sisimai::Bite - Base class for Sisimai::Bite::*
+  module Bite
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite.pm
+
+      # Data structure for parsed bounce messages
+      # @return [Hash] Data structure for delivery status
+      # @private
+      def DELIVERYSTATUS
+        return {
+          'spec'         => nil,  # Protocl specification
+          'date'         => nil,  # The value of Last-Attempt-Date header
+          'rhost'        => nil,  # The value of Remote-MTA header
+          'lhost'        => nil,  # The value of Received-From-MTA header
+          'alias'        => nil,  # The value of alias entry(RHS)
+          'agent'        => nil,  # MTA module name
+          'action'       => nil,  # The value of Action header
+          'status'       => nil,  # The value of Status header
+          'reason'       => nil,  # Temporary reason of bounce
+          'command'      => nil,  # SMTP command in the message body
+          'replycode'    => nil,  # SMTP Reply code
+          'diagnosis'    => nil,  # The value of Diagnostic-Code header
+          'recipient'    => nil,  # The value of Final-Recipient header
+          'softbounce'   => nil,  # Soft bounce or not
+          'feedbacktype' => nil,  # Feedback Type
+        }
+      end
+
+      def smtpagent(v = ''); return v.to_s.sub(/\ASisimai::Bite::/, ''); end
+      def description; return ''; end
+
+    end
+  end
+end
+
+

data/lib/sisimai/bite/email.rb

@@ -0,0 +1,53 @@
+module Sisimai
+  module Bite
+    module Email
+      # Sisimai::Bite::Email- Base class for Sisimai::Bite::Email::*
+      class << self
+        # Imported from p5-Sisimail/lib/Sisimai/Bite/Email.pm
+        require 'sisimai/bite'
+        require 'sisimai/rfc5322'
+
+        # @abstract Flags for position variable
+        # @return   [Hash] Position flag data
+        # @private
+        def INDICATORS
+          return {
+            :'deliverystatus' => (1 << 1),
+            :'message-rfc822' => (1 << 2),
+          }
+        end
+        def headerlist; return []; end
+        def pattern;    return []; end
+
+        # @abstract MTA list
+        # @return   [Array] MTA list with order
+        def index
+          return %w|
+            Sendmail Postfix Qmail Exim Courier OpenSMTPD Exchange2007 Exchange2003
+            Google Yahoo GSuite Aol Outlook Office365 SendGrid AmazonSES MailRu
+            Yandex MessagingServer Domino Notes ReceivingSES AmazonWorkMail Verizon
+            GMX Bigfoot Facebook Zoho EinsUndEins MessageLabs EZweb KDDI Biglobe
+            ApacheJames McAfee MXLogic MailFoundry IMailServer 
+            MFILTER Activehunter InterScanMSS SurfControl MailMarshalSMTP
+            X1 X2 X3 X4 X5 V5sendmail 
+          |
+        end
+
+        # @abstract Parse bounce messages
+        # @param         [Hash] mhead       Message header of a bounce email
+        # @options mhead [String] from      From header
+        # @options mhead [String] date      Date header
+        # @options mhead [String] subject   Subject header
+        # @options mhead [Array]  received  Received headers
+        # @options mhead [String] others    Other required headers
+        # @param         [String] mbody     Message body of a bounce email
+        # @return        [Hash, Nil]        Bounce data list and message/rfc822
+        #                                   part or nil if it failed to parse or
+        #                                   the arguments are missing
+        def scan; return nil; end
+
+      end
+    end
+  end
+end
+

data/lib/sisimai/bite/email/activehunter.rb

@@ -0,0 +1,124 @@
+module Sisimai::Bite::Email
+  module Activehunter
+    # Sisimai::Bite::Email::Activehunter parses a bounce email which created
+    # by TransWARE Active!hunter.
+    # Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/Activehunter.pm
+      require 'sisimai/bite/email'
+
+      Re0 = {
+        :from    => %r/\A"MAILER-DAEMON"/,
+        :subject => %r/FAILURE NOTICE :/,
+      }
+      Re1 = {
+        :begin   => %r/\A  ----- The following addresses had permanent fatal errors -----\z/,
+        :error   => %r/\A  ----- Transcript of session follows -----\z/,
+        :rfc822  => %r|\AContent-type: message/rfc822\z|,
+        :endof   => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'TransWARE Active!hunter'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def headerlist;  return ['X-AHMAILID']; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from TransWARE Active!hunter
+      # @param         [Hash] mhead       Message headers of a bounce email
+      # @options mhead [String] from      From header
+      # @options mhead [String] date      Date header
+      # @options mhead [String] subject   Subject header
+      # @options mhead [Array]  received  Received headers
+      # @options mhead [String] others    Other required headers
+      # @param         [String] mbody     Message body of a bounce email
+      # @return        [Hash, Nil]        Bounce data list and message/rfc822
+      #                                   part or nil if it failed to parse or
+      #                                   the arguments are missing
+      def scan(mhead, mbody)
+        return nil unless mhead
+        return nil unless mbody
+        return nil unless mhead['x-ahmailid']
+
+        dscontents = [Sisimai::Bite.DELIVERYSTATUS]
+        hasdivided = mbody.split("\n")
+        rfc822list = []     # (Array) Each line in message/rfc822 part string
+        blanklines = 0      # (Integer) The number of blank lines
+        readcursor = 0      # (Integer) Points the current cursor position
+        recipients = 0      # (Integer) The number of 'Final-Recipient' header
+        v = nil
+
+        hasdivided.each do |e|
+          if readcursor.zero?
+            # Beginning of the bounce message or delivery status part
+            if e =~ Re1[:begin]
+              readcursor |= Indicators[:deliverystatus]
+              next
+            end
+          end
+
+          if readcursor & Indicators[:'message-rfc822'] == 0
+            # Beginning of the original message part
+            if e =~ Re1[:rfc822]
+              readcursor |= Indicators[:'message-rfc822']
+              next
+            end
+          end
+
+          if readcursor & Indicators[:'message-rfc822'] > 0
+            # After "message/rfc822"
+            if e.empty?
+              blanklines += 1
+              break if blanklines > 1
+              next
+            end
+            rfc822list << e
+
+          else
+            # Before "message/rfc822"
+            next if readcursor & Indicators[:deliverystatus] == 0
+            next if e.empty?
+
+            #  ----- The following addresses had permanent fatal errors -----
+            #
+            # >>> kijitora@example.org <kijitora@example.org>
+            #
+            #  ----- Transcript of session follows -----
+            # 550 sorry, no mailbox here by that name (#5.1.1 - chkusr)
+            v = dscontents[-1]
+
+            if cv = e.match(/\A[>]{3}[ \t]+.+[<]([^ ]+?[@][^ ]+?)[>]\z/)
+              # >>> kijitora@example.org <kijitora@example.org>
+              if v['recipient']
+                # There are multiple recipient addresses in the message body.
+                dscontents << Sisimai::Bite.DELIVERYSTATUS
+                v = dscontents[-1]
+              end
+              v['recipient'] = cv[1]
+              recipients += 1
+
+            else
+              #  ----- Transcript of session follows -----
+              # 550 sorry, no mailbox here by that name (#5.1.1 - chkusr)
+              next unless e =~ /\A[0-9A-Za-z]+/
+              v['diagnosis'] = e
+            end
+          end
+        end
+        return nil if recipients.zero?
+        require 'sisimai/string'
+
+        dscontents.map do |e|
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+          e['agent']     = self.smtpagent
+          e.each_key { |a| e[a] ||= '' }
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end
+

data/lib/sisimai/bite/email/amazonses.rb

@@ -0,0 +1,247 @@
+module Sisimai::Bite::Email
+  module AmazonSES
+    # Sisimai::Bite::Email::AmazonSES parses a bounce email which created by
+    # Amazon Simple Email Service.
+    # Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/AmazonSES.pm
+      require 'sisimai/bite/email'
+
+      # http://aws.amazon.com/ses/
+      ReE = { :'x-mailer' => %r/Amazon[ ]WorkMail/ }
+      Re0 = {
+        :from    => %r/\AMAILER-DAEMON[@]email[-]bounces[.]amazonses[.]com\z/,
+        :subject => %r/\ADelivery Status Notification [(]Failure[)]\z/,
+      }
+      Re1 = {
+        :begin   => %r/\A(?:
+             The[ ]following[ ]message[ ]to[ ][<]
+            |An[ ]error[ ]occurred[ ]while[ ]trying[ ]to[ ]deliver[ ]the[ ]mail[ ]
+            )
+        /x,
+        :rfc822  => %r|\Acontent-type: message/rfc822\z|,
+        :endof   => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      ReFailure = {
+        expired: %r/Delivery[ ]expired/x,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'Amazon SES(Sending): http://aws.amazon.com/ses/'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+
+      # X-SenderID: Sendmail Sender-ID Filter v1.0.0 nijo.example.jp p7V3i843003008
+      # X-Original-To: 000001321defbd2a-788e31c8-2be1-422f-a8d4-cf7765cc9ed7-000000@email-bounces.amazonses.com
+      # X-AWS-Outgoing: 199.255.192.156
+      # X-SES-Outgoing: 2016.10.12-54.240.27.6
+      def headerlist;  return ['X-AWS-Outgoing', 'X-SES-Outgoing', 'x-amz-sns-message-id']; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from Amazon SES
+      # @param         [Hash] mhead       Message headers of a bounce email
+      # @options mhead [String] from      From header
+      # @options mhead [String] date      Date header
+      # @options mhead [String] subject   Subject header
+      # @options mhead [Array]  received  Received headers
+      # @options mhead [String] others    Other required headers
+      # @param         [String] mbody     Message body of a bounce email
+      # @return        [Hash, Nil]        Bounce data list and message/rfc822
+      #                                   part or nil if it failed to parse or
+      #                                   the arguments are missing
+      def scan(mhead, mbody)
+        return nil unless mhead
+        return nil unless mbody
+
+        match = 0
+        return nil if mhead['x-mailer'] =~ ReE[:'x-mailer']
+
+        match += 1 if mhead['x-aws-outgoing']
+        match += 1 if mhead['x-ses-outgoing']
+        return nil if match.zero?
+
+        dscontents = [Sisimai::Bite.DELIVERYSTATUS]
+        hasdivided = mbody.split("\n")
+        havepassed = ['']
+        rfc822list = []     # (Array) Each line in message/rfc822 part string
+        blanklines = 0      # (Integer) The number of blank lines
+        readcursor = 0      # (Integer) Points the current cursor position
+        recipients = 0      # (Integer) The number of 'Final-Recipient' header
+        connvalues = 0      # (Integer) Flag, 1 if all the value of $connheader have been set
+        connheader = {
+          'lhost' => '',    # The value of Reporting-MTA header
+        }
+        v = nil
+
+        hasdivided.each do |e|
+          # Save the current line for the next loop
+          havepassed << e
+          p = havepassed[-2]
+
+          if readcursor.zero?
+            # Beginning of the bounce message or delivery status part
+            if e =~ Re1[:begin]
+              readcursor |= Indicators[:deliverystatus]
+              next
+            end
+          end
+
+          if readcursor & Indicators[:'message-rfc822'] == 0
+            # Beginning of the original message part
+            if e =~ Re1[:rfc822]
+              readcursor |= Indicators[:'message-rfc822']
+              next
+            end
+          end
+
+          if readcursor & Indicators[:'message-rfc822'] > 0
+            # After "message/rfc822"
+            # After "message/rfc822"
+            if e.empty?
+              blanklines += 1
+              break if blanklines > 1
+              next
+            end
+            rfc822list << e
+
+          else
+            # Before "message/rfc822"
+            next if readcursor & Indicators[:deliverystatus] == 0
+            next if e.empty?
+
+            if connvalues == connheader.keys.size
+              # Final-Recipient: rfc822;kijitora@example.jp
+              # Action: failed
+              # Status: 5.0.0 (permanent failure)
+              # Remote-MTA: dns; [192.0.2.9]
+              # Diagnostic-Code: smtp; 5.1.0 - Unknown address error 550-'5.7.1
+              #  <000001321defbd2a-788e31c8-2be1-422f-a8d4-cf7765cc9ed7-000000@email-bounces.amazonses.com>...
+              #  Access denied' (delivery attempts: 0)
+              #
+              # --JuU8e.4gyIcCrxq.1RFbQY.3Vu7Hs+
+              # content-type: message/rfc822
+              v = dscontents[-1]
+
+              if cv = e.match(/\A[Ff]inal-[Rr]ecipient:[ ]*(?:RFC|rfc)822;[ ]*([^ ]+)\z/)
+                # Final-Recipient: RFC822; userunknown@example.jp
+                if v['recipient']
+                  # There are multiple recipient addresses in the message body.
+                  dscontents << Sisimai::Bite.DELIVERYSTATUS
+                  v = dscontents[-1]
+                end
+                v['recipient'] = cv[1]
+                recipients += 1
+
+              elsif cv = e.match(/\A[Xx]-[Aa]ctual-[Rr]ecipient:[ ]*(?:RFC|rfc)822;[ ]*([^ ]+)\z/)
+                # X-Actual-Recipient: RFC822; kijitora@example.co.jp
+                v['alias'] = cv[1]
+
+              elsif cv = e.match(/\A[Aa]ction:[ ]*(.+)\z/)
+                # Action: failed
+                v['action'] = cv[1].downcase
+
+              elsif cv = e.match(/\A[Ss]tatus:[ ]*(\d[.]\d+[.]\d+)/)
+                # Status: 5.1.1
+                # Status:5.2.0
+                # Status: 5.1.0 (permanent failure)
+                v['status'] = cv[1]
+
+              elsif cv = e.match(/\A[Rr]emote-MTA:[ ]*(?:DNS|dns);[ ]*(.+)\z/)
+                # Remote-MTA: DNS; mx.example.jp
+                v['rhost'] = cv[1].downcase
+
+              elsif cv = e.match(/\A[Ll]ast-[Aa]ttempt-[Dd]ate:[ ]*(.+)\z/)
+                # Last-Attempt-Date: Fri, 14 Feb 2014 12:30:08 -0500
+                v['date'] = cv[1]
+
+              else
+                if cv = e.match(/\A[Dd]iagnostic-[Cc]ode:[ ]*(.+?);[ ]*(.+)\z/)
+                  # Diagnostic-Code: SMTP; 550 5.1.1 <userunknown@example.jp>... User Unknown
+                  v['spec'] = cv[1].upcase
+                  v['diagnosis'] = cv[2]
+
+                elsif p =~ /\A[Dd]iagnostic-[Cc]ode:[ ]*/ && cv = e.match(/\A[ \t]+(.+)\z/)
+                  # Continued line of the value of Diagnostic-Code header
+                  v['diagnosis'] ||= ''
+                  v['diagnosis']  += ' ' + cv[1]
+                  havepassed[-1] = 'Diagnostic-Code: ' + e
+                end
+              end
+
+            else
+              # The following message to <kijitora@example.jp> was undeliverable.
+              # The reason for the problem:
+              # 5.1.0 - Unknown address error 550-'5.7.1 <0000000000000000-00000000-0000-00=
+              # 00-0000-000000000000-000000@email-bounces.amazonses.com>... Access denied'
+              #
+              # --JuU8e.4gyIcCrxq.1RFbQY.3Vu7Hs+
+              # content-type: message/delivery-status
+              #
+              # Reporting-MTA: dns; a192-79.smtp-out.amazonses.com
+              #
+              if cv = e.match(/\A[Rr]eporting-MTA:[ ]*[DNSdns]+;[ ]*(.+)\z/)
+                # Reporting-MTA: dns; mx.example.jp
+                next if connheader['lhost'].size > 0
+                connheader['lhost'] = cv[1].downcase
+                connvalues += 1
+              end
+
+            end
+          end
+        end
+
+        if recipients.zero? && mbody =~ /notificationType/
+          # Try to parse with Sisimai::Bite::JSON::AmazonSES module
+          require 'sisimai/bite/json/amazonses'
+          e = Sisimai::Bite::JSON::AmazonSES.scan(mhead, mbody)
+
+          if e['ds'].is_a? Array
+            # Update dscontents
+            dscontents = e['ds']
+            recipients = e['ds'].size
+          end
+        end
+
+        return nil if recipients.zero?
+        require 'sisimai/string'
+        require 'sisimai/smtp/status'
+
+        dscontents.map do |e|
+          # Set default values if each value is empty.
+          connheader.each_key { |a| e[a] ||= connheader[a] || '' }
+
+          e['diagnosis'] ||= ''
+          e['diagnosis']   = e['diagnosis'].gsub(/\\n/, ' ')
+          e['diagnosis']   = Sisimai::String.sweep(e['diagnosis'])
+
+          if e['status'] =~ /\A[45][.][01][.]0\z/
+            # Get other D.S.N. value from the error message
+            errormessage = e['diagnosis']
+
+            if cv = e['diagnosis'].match(/["'](\d[.]\d[.]\d.+)['"]/)
+              # 5.1.0 - Unknown address error 550-'5.7.1 ...
+              errormessage = cv[1]
+            end
+
+            pseudostatus = Sisimai::SMTP::Status.find(errormessage)
+            e['status'] = pseudostatus if pseudostatus.size > 0
+          end
+
+          ReFailure.each_key do |r|
+            # Verify each regular expression of session errors
+            next unless e['diagnosis'] =~ ReFailure[r]
+            e['reason'] = r.to_s
+            break
+          end
+
+          e['reason'] ||= Sisimai::SMTP::Status.name(e['status'])
+          e['agent']    = self.smtpagent
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end
+