sisimai 4.21.1 → 4.22.0

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

@@ -0,0 +1,273 @@
+module Sisimai::Bite::Email
+  module GSuite
+    # Sisimai::Bite::Email::GSuite parses a bounce email which created by G Suite.
+    # Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/GSuite.pm
+      require 'sisimai/bite/email'
+
+      Re0 = {
+        :from    => %r/[@]googlemail[.]com[>]?\z/,
+        :subject => %r/Delivery[ ]Status[ ]Notification/,
+      }
+      Re1 = {
+        :begin   => %r/\A[*][*][ ].+[ ][*][*]\z/,
+        :error   => %r/\AThe[ ]response([ ]from[ ]the[ ]remote[ ]server)?[ ]was:\z/,
+        :html    => %r{\AContent-Type:[ ]*text/html;[ ]*charset=['"]?(?:UTF|utf)[-]8['"]?\z},
+        :rfc822  => %r{\AContent-Type:[ ]*(?:message/rfc822|text/rfc822-headers)\z},
+        :endof   => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      ErrorMayBe = {
+        :userunknown  => %r/because the address couldn't be found/,
+        :notaccept    => %r/Null MX/,
+        :networkerror => %r/DNS type .+ lookup of .+ responded with code NXDOMAIN/,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'G Suite: https://gsuite.google.com'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def headerlist;  return ['X-Gm-Message-State']; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from G Suite (Transfer from G Suite to a destinaion host)
+      # @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['from']    =~ Re0[:from]
+        return nil unless mhead['subject'] =~ Re0[:subject]
+        return nil unless mhead['x-gm-message-state']
+
+        require 'sisimai/address'
+        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
+        endoferror = true   # (Integer) Flag for a blank line after error messages
+        anotherset = {}     # (Hash) Another error information
+        emptylines = 0      # (Integer) The number of empty lines
+        connvalues = 0      # (Integer) Flag, 1 if all the value of $connheader have been set
+        connheader = {
+          'date'  => '',    # The value of Arrival-Date header
+          'lhost' => '',    # The value of Reporting-MTA 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]
+            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
+
+            if connvalues == connheader.keys.size
+              # Final-Recipient: rfc822; kijitora@example.de
+              # Action: failed
+              # Status: 5.0.0
+              # Remote-MTA: dns; 192.0.2.222 (192.0.2.222, the server for the domain.)
+              # Diagnostic-Code: smtp; 550 #5.1.0 Address rejected.
+              # Last-Attempt-Date: Fri, 24 Mar 2017 23:34:10 -0700 (PDT)
+              v = dscontents[-1]
+
+              if cv = e.match(/\A[Ff]inal-[Rr]ecipient:[ ]*(?:RFC|rfc)822;[ ]*(.+)\z/)
+                # Final-Recipient: rfc822; kijitora@example.de
+                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[Aa]ction:[ ]*(.+)\z/)
+                # Action: failed
+                v['action'] = cv[1].downcase
+
+              elsif cv = e.match(/\A[Ss]tatus:[ ]*(\d[.]\d+[.]\d+)/)
+                # Status: 5.0.0
+                v['status'] = cv[1]
+
+              elsif cv = e.match(/\A[Rr]emote-MTA:[ ]*(?:DNS|dns);[ ]*(.+)\z/)
+                # Remote-MTA: dns; 192.0.2.222 (192.0.2.222, the server for the domain.)
+                v['rhost'] = cv[1].downcase
+                v['rhost'] = '' if v['rhost'] =~ /\A\s+\z/  # Remote-MTA: DNS;
+
+              elsif cv = e.match(/\A[Ll]ast-[Aa]ttempt-[Dd]ate:[ ]*(.+)\z/)
+                # Last-Attempt-Date: Fri, 24 Mar 2017 23:34:10 -0700 (PDT)
+                v['date'] = cv[1]
+
+              else
+                if cv = e.match(/\A[Dd]iagnostic-[Cc]ode:[ ]*(.+?);[ ]*(.+)\z/)
+                  # Diagnostic-Code: smtp; 550 #5.1.0 Address rejected.
+                  v['spec'] = cv[1].upcase
+                  v['diagnosis'] = cv[2]
+                else
+                  # Append error messages continued from the previous line
+                  if endoferror && ( v['diagnosis'] && v['diagnosis'].size > 0 )
+                    endoferror = true if e.empty?
+                    endoferror = true if e =~ /\A--/
+
+                    next if endoferror
+                    next unless e =~ /\A[ ]/
+                    v['diagnosis'] += e
+                  end
+                end
+              end
+
+            else
+              # Reporting-MTA: dns; googlemail.com
+              # Received-From-MTA: dns; sironeko@example.jp
+              # Arrival-Date: Fri, 24 Mar 2017 23:34:07 -0700 (PDT)
+              # X-Original-Message-ID: <06C1ED5C-7E02-4036-AEE1-AA448067FB2C@example.jp>
+              if cv = e.match(/\A[Rr]eporting-MTA:[ ]*(?:DNS|dns);[ ]*(.+)\z/)
+                # Reporting-MTA: dns; mx.example.jp
+                next if connheader['lhost'].size > 0
+                connheader['lhost'] = cv[1].downcase
+                connvalues += 1
+
+              elsif cv = e.match(/\A[Aa]rrival-[Dd]ate:[ ]*(.+)\z/)
+                # Arrival-Date: Wed, 29 Apr 2009 16:03:18 +0900
+                next if connheader['date'].size > 0
+                connheader['date'] = 1
+                connvalues += 1
+
+              else
+                # Detect SMTP session error or connection error
+                if e =~ Re1[:error]
+                  # The response from the remote server was:
+                  anotherset['diagnosis'] += e
+                else
+                  # ** Address not found **
+                  #
+                  # Your message wasn't delivered to * because the address couldn't be found.
+                  # Check for typos or unnecessary spaces and try again.
+                  #
+                  # The response from the remote server was:
+                  # 550 #5.1.0 Address rejected.
+                  next if e =~ Re1[:html]
+
+                  if anotherset['diagnosis']
+                    # Continued error messages from the previous line like
+                    # "550 #5.1.0 Address rejected."
+                    next if emptylines > 5
+                    if e.empty?
+                      # Count and next()
+                      emptylines += 1
+                      next
+                    end
+                    anotherset['diagnosis'] += ' ' + e
+                  else
+                    # ** Address not found **
+                    #
+                    # Your message wasn't delivered to * because the address couldn't be found.
+                    # Check for typos or unnecessary spaces and try again.
+                    next if e.empty?
+                    next unless e =~ Re1[:begin]
+                    anotherset['diagnosis'] = e
+                  end
+                end
+
+              end
+            end
+          end
+        end
+
+        return nil if recipients.zero?
+        require 'sisimai/string'
+        require 'sisimai/smtp/reply'
+        require 'sisimai/smtp/status'
+
+        dscontents.map do |e|
+          # Set default values if each value is empty.
+          connheader.each_key { |a| e[a] ||= connheader[a] || '' }
+
+          if anotherset['diagnosis']
+            # Copy alternative error message
+            e['diagnosis'] = anotherset['diagnosis'] unless e['diagnosis']
+
+            if e['diagnosis'] =~ /\A\d+\z/
+              e['diagnosis'] = anotherset['diagnosis']
+            else
+              # More detailed error message is in "$anotherset"
+              as = nil  # status
+              ar = nil  # replycode
+
+              if e['status'] == '' || e['status'] =~ /\A[45][.]0[.]0\z/
+                # Check the value of D.S.N. in $anotherset
+                as = Sisimai::SMTP::Status.find(anotherset['diagnosis'])
+                if as.size > 0 && as[-3, 3] != '0.0'
+                  # The D.S.N. is neither an empty nor *.0.0
+                  e['status'] = as
+                end
+              end
+
+              if e['replycode'] == '' || e['replycode'] =~ /\A[45]00\z/
+                # Check the value of SMTP reply code in $anotherset
+                ar = Sisimai::SMTP::Reply.find(anotherset['diagnosis'])
+                if ar.size > 0 && ar[-2, 2].to_i != 0
+                  # The SMTP reply code is neither an empty nor *00
+                  e['replycode'] = ar
+                end
+              end
+
+              if ( as || ar ) && ( anotherset['diagnosis'].size > e['diagnosis'].size )
+                # Update the error message in $e->{'diagnosis'}
+                e['diagnosis'] = anotherset['diagnosis']
+              end
+            end
+          end
+
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+          e['agent']     = self.smtpagent
+
+          ErrorMayBe.each_key do |q|
+            # Guess an reason of the bounce
+            next unless e['diagnosis'] =~ ErrorMayBe[q]
+            e['reason'] = q.to_s
+            break
+          end
+
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end
+

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

@@ -0,0 +1,181 @@
+module Sisimai::Bite::Email
+  module IMailServer
+    # Sisimai::Bite::Email::IMailServer parses a bounce email which created by
+    # Ipswitch IMail Server.
+    # Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite::Email/IMailServer.pm
+      require 'sisimai/bite/email'
+
+      Re0 = {
+        :'x-mailer' => %r/\A[<]SMTP32 v[\d.]+[>][ ]*\z/,
+        :'subject'  => %r/\AUndeliverable Mail[ ]*\z/,
+      }
+      Re1 = {
+        :begin  => %r/\A\z/,    # Blank line
+        :error  => %r/Body of message generated response:/,
+        :rfc822 => %r/\AOriginal message follows[.]\z/,
+        :endof  => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      ReSMTP = {
+        conn: %r{(?:
+             SMTP[ ]connection[ ]failed,
+            |Unexpected[ ]connection[ ]response[ ]from[ ]server:
+            )
+        },
+        ehlo: %r|Unexpected response to EHLO/HELO:|,
+        mail: %r|Server response to MAIL FROM:|,
+        rcpt: %r|Additional RCPT TO generated following response:|,
+        data: %r|DATA command generated response:|,
+      }
+      ReFailure = {
+        hostunknown: %r/Unknown[ ]host/x,
+        userunknown: %r/\A(?:Unknown[ ]user|Invalid[ ]final[ ]delivery[ ]userid)/x,
+        mailboxfull: %r/\AUser[ ]mailbox[ ]exceeds[ ]allowed[ ]size/x,
+        securityerr: %r/\ARequested[ ]action[ ]not[ ]taken:[ ]virus[ ]detected/x,
+        undefined:   %r/\Aundeliverable[ ]to[ ]/x,
+        expired:     %r/\ADelivery[ ]failed[ ]\d+[ ]attempts/x,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'IPSWITCH IMail Server'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def headerlist;  return ['X-Mailer']; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from IMailServer
+      # @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
+        match += 1 if mhead['subject'] =~ Re0[:subject]
+        match += 1 if mhead['x-mailer'] && mhead['x-mailer'] =~ Re0[:'x-mailer']
+        return nil if match.zero?
+
+        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"
+            break if readcursor & Indicators[:'message-rfc822'] > 0
+
+            # Unknown user: kijitora@example.com
+            #
+            # Original message follows.
+            v = dscontents[-1]
+
+            if cv = e.match(/\A(.+)[ ](.+)[:][ \t]*([^ ]+[@][^ ]+)/)
+              # Unknown user: kijitora@example.com
+              if v['recipient']
+                # There are multiple recipient addresses in the message body.
+                dscontents << Sisimai::Bite.DELIVERYSTATUS
+                v = dscontents[-1]
+              end
+              v['diagnosis'] = cv[1] + ' ' + cv[2]
+              v['recipient'] = cv[3]
+              recipients += 1
+
+            elsif cv = e.match(/\Aundeliverable[ ]+to[ ]+(.+)\z/)
+              # undeliverable to kijitora@example.com
+              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
+              # Other error message text
+              v['alterrors']  += ' ' + e if v['alterrors']
+              if e =~ Re1[:error]
+                # Body of message generated response:
+                v['alterrors'] = e
+              end
+            end
+          end
+        end
+        return nil if recipients.zero?
+        require 'sisimai/string'
+
+        dscontents.map do |e|
+          e['agent'] = self.smtpagent
+
+          if e['alterrors'] && e['alterrors'].size > 0
+            # Copy alternative error message
+            if e['diagnosis']
+              e['diagnosis'] = e['alterrors'] + ' ' + e['diagnosis']
+            else
+              e['diagnosis'] = e['alterrors']
+            end
+            e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+            e.delete('alterrors')
+          end
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+
+          ReSMTP.each_key do |r|
+            # Detect SMTP command from the message
+            next unless e['diagnosis'] =~ ReSMTP[r]
+            e['command'] = r.to_s.upcase
+            break
+          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.each_key { |a| e[a] ||= '' }
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end
+