sisimai 4.25.3 → 4.25.8

data/lib/sisimai/lhost/gmx.rb

@@ -0,0 +1,114 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::GMX parses a bounce email which created by GMX.
+  # Methods in the module are called from only Sisimai::Message.
+  module GMX
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/GMX.pm
+      require 'sisimai/lhost'
+
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r|^---[ ]The[ ]header[ ]of[ ]the[ ]original[ ]message[ ]is[ ]following[.][ ]---|.freeze
+      StartingOf = { message: ['This message was created automatically by mail delivery software'] }.freeze
+      MessagesOf = { 'expired' => ['delivery retry timeout exceeded'] }.freeze
+
+      # Parse bounce messages from GMX
+      # @param  [Hash] mhead    Message headers of a bounce email
+      # @param  [String] mbody  Message body of a bounce email
+      # @return [Hash]          Bounce data list and message/rfc822 part
+      # @return [Nil]           it failed to parse or the arguments are missing
+      def make(mhead, mbody)
+        # Envelope-To: <kijitora@mail.example.com>
+        # X-GMX-Antispam: 0 (Mail was not recognized as spam); Detail=V3;
+        # X-GMX-Antivirus: 0 (no virus found)
+        # X-UI-Out-Filterresults: unknown:0;
+        return nil unless mhead['x-gmx-antispam']
+
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
+        emailsteak = Sisimai::RFC5322.fillet(mbody, ReBackbone)
+        bodyslices = emailsteak[0].split("\n")
+        readcursor = 0      # (Integer) Points the current cursor position
+        recipients = 0      # (Integer) The number of 'Final-Recipient' header
+        v = nil
+
+        while e = bodyslices.shift do
+          # Read error messages and delivery status lines from the head of the email
+          # to the previous line of the beginning of the original message.
+          if readcursor == 0
+            # Beginning of the bounce message or delivery status part
+            readcursor |= Indicators[:deliverystatus] if e.start_with?(StartingOf[:message][0])
+            next
+          end
+          next if (readcursor & Indicators[:deliverystatus]) == 0
+          next if e.empty?
+
+          # This message was created automatically by mail delivery software.
+          #
+          # A message that you sent could not be delivered to one or more of
+          # its recipients. This is a permanent error. The following address
+          # failed:
+          #
+          # "shironeko@example.jp":
+          # SMTP error from remote server after RCPT command:
+          # host: mx.example.jp
+          # 5.1.1 <shironeko@example.jp>... User Unknown
+          v = dscontents[-1]
+
+          if cv = e.match(/\A["]([^ ]+[@][^ ]+)["]:\z/) || e.match(/\A[<]([^ ]+[@][^ ]+)[>]\z/)
+            # "shironeko@example.jp":
+            # ---- OR ----
+            # <kijitora@6jo.example.co.jp>
+            #
+            # Reason:
+            # delivery retry timeout exceeded
+            if v['recipient']
+              # There are multiple recipient addresses in the message body.
+              dscontents << Sisimai::Lhost.DELIVERYSTATUS
+              v = dscontents[-1]
+            end
+            v['recipient'] = cv[1]
+            recipients += 1
+
+          elsif cv = e.match(/\ASMTP error .+ ([A-Z]{4}) command:\z/)
+            # SMTP error from remote server after RCPT command:
+            v['command'] = cv[1]
+
+          elsif cv = e.match(/\Ahost:[ \t]*(.+)\z/)
+            # host: mx.example.jp
+            v['rhost'] = cv[1]
+          else
+            # Get error message
+            if e =~ /\b[45][.]\d[.]\d\b/ || e =~ /[<][^ ]+[@][^ ]+[>]/ || e =~ /\b[45]\d{2}\b/
+              v['diagnosis'] ||= e
+            else
+              next if e.empty?
+              if e.start_with?('Reason:')
+                # Reason:
+                # delivery retry timeout exceeded
+                v['diagnosis'] = e
+
+              elsif v['diagnosis'] == 'Reason:'
+                v['diagnosis'] = e
+              end
+            end
+          end
+        end
+        return nil unless recipients > 0
+
+        dscontents.each do |e|
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'].tr("\n", ' '))
+
+          MessagesOf.each_key do |r|
+            # Verify each regular expression of session errors
+            next unless MessagesOf[r].any? { |a| e['diagnosis'].include?(a) }
+            e['reason'] = r
+            break
+          end
+        end
+
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'GMX: https://www.gmx.net'; end
+    end
+  end
+end
+

data/lib/sisimai/lhost/googlegroups.rb

@@ -0,0 +1,77 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::GoogleGroups parses a bounce email which created by Google
+  # Groups. Methods in the module are called from only Sisimai::Message.
+  module GoogleGroups
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/GoogleGroups.pm
+      require 'sisimai/lhost'
+
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r/^-----[ ]Original[ ]message[ ]-----$/.freeze
+
+      # Parse bounce messages from Google Groups
+      # @param  [Hash] mhead    Message headers of a bounce email
+      # @param  [String] mbody  Message body of a bounce email
+      # @return [Hash]          Bounce data list and message/rfc822 part
+      # @return [Nil]           it failed to parse or the arguments are missing
+      # @since v4.25.6
+      def make(mhead, mbody)
+        return nil unless mhead['from'].end_with?('<mailer-daemon@googlemail.com>')
+        return nil unless mhead['subject'].start_with?('Delivery Status Notification')
+        return nil unless mhead['x-failed-recipients']
+        return nil unless mhead['x-failed-recipients'].include?('@googlegroups.com')
+
+        # Hello kijitora@libsisimai.org,
+        #
+        # We're writing to let you know that the group you tried to contact (group-name)
+        # may not exist, or you may not have permission to post messages to the group.
+        # A few more details on why you weren't able to post:
+        #
+        #  * You might have spelled or formatted the group name incorrectly.
+        #  * The owner of the group may have removed this group.
+        #  * You may need to join the group before receiving permission to post.
+        #  * This group may not be open to posting.
+        #
+        # If you have questions related to this or any other Google Group,
+        # visit the Help Center at https://groups.google.com/support/.
+        #
+        # Thanks,
+        #
+        # Google Groups
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
+        emailsteak = Sisimai::RFC5322.fillet(mbody, ReBackbone)
+        recordwide = { 'rhost' => '', 'reason' => '', 'diagnosis' => '' }
+        recipients = 0
+        v = dscontents[-1]
+
+        # * You might have spelled or formatted the group name incorrectly.
+        # * The owner of the group may have removed this group.
+        # * You may need to join the group before receiving permission to post.
+        # * This group may not be open to posting.
+        entiremesg = emailsteak[0].split(/\n\n/, 5).slice(0, 4).join(' ').tr("\n", ' ');
+        recordwide['diagnosis'] = Sisimai::String.sweep(entiremesg)
+        recordwide['reason']    = emailsteak[0].scan(/^[ ]?[*][ ]?/).size == 4 ? 'rejected' : 'onhold'
+        recordwide['rhost']     = Sisimai::RFC5322.received(mhead['received'][0]).shift
+
+        mhead['x-failed-recipients'].split(',').each do |e|
+          # X-Failed-Recipients: neko@example.jp, nyaan@example.org, ...
+          next unless e.end_with?('@googlegroups.com')
+          next unless Sisimai::RFC5322.is_emailaddress(e)
+
+          if v['recipient']
+            # There are multiple recipient addresses in the message body.
+            dscontents << Sisimai::Lhost.DELIVERYSTATUS
+            v = dscontents[-1]
+          end
+          v['recipient'] = Sisimai::Address.s3s4(e)
+          recipients += 1
+          recordwide.each_key { |r| v[r] = recordwide[r] }
+        end
+        return nil unless recipients > 0
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'Google Groups: https://groups.google.com'; end
+    end
+  end
+end
+

data/lib/sisimai/lhost/gsuite.rb

@@ -0,0 +1,196 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::GSuite parses a bounce email which created by G Suite.
+  # Methods in the module are called from only Sisimai::Message.
+  module GSuite
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/GSuite.pm
+      require 'sisimai/lhost'
+
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r<^Content-Type:[ ](?:message/rfc822|text/rfc822-headers)>.freeze
+      MarkingsOf = {
+        message: %r/\A[*][*][ ].+[ ][*][*]\z/,
+        error:   %r/\AThe[ ]response([ ]from[ ]the[ ]remote[ ]server)?[ ]was:\z/,
+        html:    %r{\AContent-Type:[ ]*text/html;[ ]*charset=['"]?(?:UTF|utf)[-]8['"]?\z},
+      }.freeze
+      MessagesOf = {
+        'userunknown'  => ["because the address couldn't be found. Check for typos or unnecessary spaces and try again."],
+        'notaccept'    => ['Null MX'],
+        'networkerror' => [' had no relevant answers.', ' responded with code NXDOMAIN'],
+      }.freeze
+
+      # Parse bounce messages from G Suite (Transfer from G Suite to a destinaion host)
+      # @param  [Hash] mhead    Message headers of a bounce email
+      # @param  [String] mbody  Message body of a bounce email
+      # @return [Hash]          Bounce data list and message/rfc822 part
+      # @return [Nil]           it failed to parse or the arguments are missing
+      def make(mhead, mbody)
+        return nil unless mhead['from'].end_with?('<mailer-daemon@googlemail.com>')
+        return nil unless mhead['subject'].start_with?('Delivery Status Notification')
+        return nil unless mhead['x-gm-message-state']
+
+        require 'sisimai/rfc1894'
+        fieldtable = Sisimai::RFC1894.FIELDTABLE
+        permessage = {}     # (Hash) Store values of each Per-Message field
+
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
+        emailsteak = Sisimai::RFC5322.fillet(mbody, ReBackbone)
+        bodyslices = emailsteak[0].split("\n")
+        readcursor = 0      # (Integer) Points the current cursor position
+        recipients = 0      # (Integer) The number of 'Final-Recipient' header
+        endoferror = false  # (Integer) Flag for a blank line after error messages
+        anotherset = {}     # (Hash) Another error information
+        emptylines = 0      # (Integer) The number of empty lines
+        v = nil
+
+        while e = bodyslices.shift do
+          # Read error messages and delivery status lines from the head of the email
+          # to the previous line of the beginning of the original message.
+          if readcursor == 0
+            # Beginning of the bounce message or message/delivery-status part
+            readcursor |= Indicators[:deliverystatus] if e =~ MarkingsOf[:message]
+          end
+          next if (readcursor & Indicators[:deliverystatus]) == 0
+
+          if f = Sisimai::RFC1894.match(e)
+            # "e" matched with any field defined in RFC3464
+            next unless o = Sisimai::RFC1894.field(e)
+            v = dscontents[-1]
+
+            if o[-1] == 'addr'
+              # Final-Recipient: rfc822; kijitora@example.jp
+              # X-Actual-Recipient: rfc822; kijitora@example.co.jp
+              if o[0] == 'final-recipient'
+                # Final-Recipient: rfc822; kijitora@example.jp
+                if v['recipient']
+                  # There are multiple recipient addresses in the message body.
+                  dscontents << Sisimai::Lhost.DELIVERYSTATUS
+                  v = dscontents[-1]
+                end
+                v['recipient'] = o[2]
+                recipients += 1
+              else
+                # X-Actual-Recipient: rfc822; kijitora@example.co.jp
+                v['alias'] = o[2]
+              end
+            elsif o[-1] == 'code'
+              # Diagnostic-Code: SMTP; 550 5.1.1 <userunknown@example.jp>... User Unknown
+              v['spec'] = o[1]
+              v['diagnosis'] = o[2]
+            else
+              # Other DSN fields defined in RFC3464
+              next unless fieldtable[o[0]]
+              v[fieldtable[o[0]]] = o[2]
+
+              next unless f == 1
+              permessage[fieldtable[o[0]]] = o[2]
+            end
+          else
+            # The line does not begin with a DSN field defined in RFC3464
+            # Append error messages continued from the previous line
+            if endoferror == false && v && ! v['diagnosis'].to_s.empty?
+              endoferror ||= true if e.empty?
+
+              next if endoferror
+              next unless e.start_with?(' ')
+              v['diagnosis'] << e
+
+            elsif e =~ MarkingsOf[:error]
+              # Detect SMTP session error or connection 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 =~ MarkingsOf[:html]
+
+              if anotherset['diagnosis']
+                # Continued error messages from the previous line like
+                # "550 #5.1.0 Address rejected."
+                next if e =~ /\AContent-Type:/
+                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 =~ MarkingsOf[:message]
+                anotherset['diagnosis'] = e
+              end
+            end
+          end
+        end
+        return nil unless recipients > 0
+
+        dscontents.each do |e|
+          # Set default values if each value is empty.
+          e['lhost'] ||= permessage['rhost']
+          permessage.each_key { |a| e[a] ||= permessage[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
+
+              e['status']    ||= ''
+              e['replycode'] ||= ''
+
+              if e['status'] == '' || e['status'].start_with?('4.0.0', '5.0.0')
+                # Check the value of D.S.N. in anotherset
+                as = Sisimai::SMTP::Status.find(anotherset['diagnosis'])
+                if as && as[-3, 3] != '0.0'
+                  # The D.S.N. is neither an empty nor *.0.0
+                  e['status'] = as
+                end
+              end
+
+              if e['replycode'].empty? || e['replycode'].start_with?('400', '500')
+                # Check the value of SMTP reply code in anotherset
+                ar = Sisimai::SMTP::Reply.find(anotherset['diagnosis'])
+                if ar && 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'])
+          MessagesOf.each_key do |r|
+            # Guess an reason of the bounce
+            next unless MessagesOf[r].any? { |a| e['diagnosis'].include?(a) }
+            e['reason'] = r
+            break
+          end
+        end
+
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'G Suite: https://gsuite.google.com'; end
+    end
+  end
+end
+

data/lib/sisimai/lhost/imailserver.rb

@@ -0,0 +1,118 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::IMailServer parses a bounce email which created by
+  # Ipswitch IMail Server.
+  # Methods in the module are called from only Sisimai::Message.
+  module IMailServer
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/IMailServer.pm
+      require 'sisimai/lhost'
+
+      ReBackbone = %r|^Original[ ]message[ ]follows[.]|.freeze
+      StartingOf = { error: ['Body of message generated response:'] }.freeze
+
+      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:|,
+      }.freeze
+      ReFailures = {
+        'hostunknown'   => %r/Unknown host/,
+        'userunknown'   => %r/\A(?:Unknown user|Invalid final delivery userid)/,
+        'mailboxfull'   => %r/\AUser mailbox exceeds allowed size/,
+        'securityerror' => %r/\ARequested action not taken: virus detected/,
+        'undefined'     => %r/\Aundeliverable to /,
+        'expired'       => %r/\ADelivery failed \d+ attempts/,
+      }.freeze
+
+      # Parse bounce messages from IMailServer
+      # @param  [Hash] mhead    Message headers of a bounce email
+      # @param  [String] mbody  Message body of a bounce email
+      # @return [Hash]          Bounce data list and message/rfc822 part
+      # @return [Nil]           it failed to parse or the arguments are missing
+      def make(mhead, mbody)
+        # X-Mailer: <SMTP32 v8.22>
+        match  = 0
+        match += 1 if mhead['subject'] =~ /\AUndeliverable Mail[ ]*\z/
+        match += 1 if mhead['x-mailer'].to_s.start_with?('<SMTP32 v')
+        return nil unless match > 0
+
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
+        emailsteak = Sisimai::RFC5322.fillet(mbody, ReBackbone)
+        bodyslices = emailsteak[0].split("\n")
+        recipients = 0      # (Integer) The number of 'Final-Recipient' header
+        v = nil
+
+        while e = bodyslices.shift do
+          # Read error messages and delivery status lines from the head of the email
+          # to the previous line of the beginning of the original message.
+
+          # 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::Lhost.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::Lhost.DELIVERYSTATUS
+              v = dscontents[-1]
+            end
+            v['recipient'] = cv[1]
+            recipients += 1
+          else
+            # Other error message text
+            v['alterrors'] << ' ' << e if v['alterrors']
+            v['alterrors'] = e if e.include?(StartingOf[:error][0])
+          end
+        end
+        return nil unless recipients > 0
+
+        dscontents.each do |e|
+          unless e['alterrors'].to_s.empty?
+            # Copy alternative error message
+            e['diagnosis'] = if e['diagnosis']
+                               e['alterrors'] + ' ' + e['diagnosis']
+                             else
+                               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.upcase
+            break
+          end
+
+          ReFailures.each_key do |r|
+            # Verify each regular expression of session errors
+            next unless e['diagnosis'] =~ ReFailures[r]
+            e['reason'] = r
+            break
+          end
+        end
+
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'IPSWITCH IMail Server'; end
+    end
+  end
+end
+