sisimai 4.25.3 → 4.25.8

data/lib/sisimai/lhost/bigfoot.rb

@@ -0,0 +1,126 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::Bigfoot parses a bounce email which created by Bigfoot.
+  # Methods in the module are called from only Sisimai::Message.
+  module Bigfoot
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/Bigfoot.pm
+      require 'sisimai/lhost'
+
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r|^Content-Type:[ ]message/partial|.freeze
+      MarkingsOf = { message: %r/\A[ \t]+[-]+[ \t]*Transcript of session follows/ }.freeze
+
+      # Parse bounce messages from Bigfoot
+      # @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)
+        # :subject  => %r/\AReturned mail: /,
+        match  = 0
+        match += 1 if mhead['from'].include?('@bigfoot.com>')
+        match += 1 if mhead['received'].any? { |a| a.include?('.bigfoot.com') }
+        return nil unless match > 0
+
+        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")
+        readslices = ['']
+        readcursor = 0      # (Integer) Points the current cursor position
+        recipients = 0      # (Integer) The number of 'Final-Recipient' header
+        commandtxt = ''     # (String) SMTP Command name begin with the string '>>>'
+        esmtpreply = ''     # (String) Reply from remote server on SMTP session
+        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.
+          readslices << e # Save the current line for the next loop
+
+          if readcursor == 0
+            # Beginning of the bounce message or message/delivery-status part
+            readcursor |= Indicators[:deliverystatus] if e =~ MarkingsOf[:message]
+            next
+          end
+          next if (readcursor & Indicators[:deliverystatus]) == 0
+          next if e.empty?
+
+          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
+            unless e.start_with?(' ')
+              #    ----- Transcript of session follows -----
+              # >>> RCPT TO:<destinaion@example.net>
+              # <<< 553 Invalid recipient destinaion@example.net (Mode: normal)
+              if cv = e.match(/\A[>]{3}[ ]+([A-Z]{4})[ ]?/)
+                # >>> DATA
+                commandtxt = cv[1]
+              elsif cv = e.match(/\A[<]{3}[ ]+(.+)\z/)
+                # <<< Response
+                esmtpreply = cv[1]
+              end
+            else
+              # Continued line of the value of Diagnostic-Code field
+              next unless readslices[-2].start_with?('Diagnostic-Code:')
+              next unless cv = e.match(/\A[ \t]+(.+)\z/)
+              v['diagnosis'] << ' ' << cv[1]
+              readslices[-1] = 'Diagnostic-Code: ' << e
+            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] || '' }
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+          e['command']   = commandtxt
+          if e['command'].empty?
+            e['command'] = 'EHLO' unless esmtpreply.empty?
+          end
+        end
+
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'Bigfoot: http://www.bigfoot.com'; end
+    end
+  end
+end
+

data/lib/sisimai/lhost/biglobe.rb

@@ -0,0 +1,101 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::Biglobe parses a bounce email which created by BIGLOBE.
+  # Methods in the module are called from only Sisimai::Message.
+  module Biglobe
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/Biglobe.pm
+      require 'sisimai/lhost'
+
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r|^Content-Type:[ ]message/rfc822|.freeze
+      StartingOf = {
+        message: ['   ----- The following addresses had delivery problems -----'],
+        error:   ['   ----- Non-delivered information -----'],
+      }.freeze
+      MessagesOf = {
+        'filtered'    => ['Mail Delivery Failed... User unknown'],
+        'mailboxfull' => ["The number of messages in recipient's mailbox exceeded the local limit."],
+      }.freeze
+
+      # Parse bounce messages from Biglobe
+      # @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'] =~ /postmaster[@](?:biglobe|inacatv|tmtv|ttv)[.]ne[.]jp/
+        return nil unless mhead['subject'].start_with?('Returned mail:')
+
+        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 == StartingOf[:message][0]
+            next
+          end
+          next if (readcursor & Indicators[:deliverystatus]) == 0
+          next if e.empty?
+
+          # This is a MIME-encapsulated message.
+          #
+          # ----_Biglobe000000/00000.biglobe.ne.jp
+          # Content-Type: text/plain; charset="iso-2022-jp"
+          #
+          #    ----- The following addresses had delivery problems -----
+          # ********@***.biglobe.ne.jp
+          #
+          #    ----- Non-delivered information -----
+          # The number of messages in recipient's mailbox exceeded the local limit.
+          #
+          # ----_Biglobe000000/00000.biglobe.ne.jp
+          # Content-Type: message/rfc822
+          #
+          v = dscontents[-1]
+
+          if cv = e.match(/\A([^ ]+[@][^ ]+)\z/)
+            #    ----- The following addresses had delivery problems -----
+            # ********@***.biglobe.ne.jp
+            if v['recipient']
+              # There are multiple recipient addresses in the message body.
+              dscontents << Sisimai::Lhost.DELIVERYSTATUS
+              v = dscontents[-1]
+            end
+
+            r = Sisimai::Address.s3s4(cv[1])
+            next unless Sisimai::RFC5322.is_emailaddress(r)
+            v['recipient'] = r
+            recipients += 1
+          else
+            next if e =~ /\A[^\w]/
+            v['diagnosis'] ||= ''
+            v['diagnosis'] << e + ' '
+          end
+        end
+        return nil unless recipients > 0
+
+        dscontents.each do |e|
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+
+          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 'BIGLOBE: https://www.biglobe.ne.jp'; end
+    end
+  end
+end
+

data/lib/sisimai/lhost/courier.rb

@@ -0,0 +1,146 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::Courier parses a bounce email which created by Courier
+  # MTA. Methods in the module are called from only Sisimai::Message.
+  module Courier
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/Courier.pm
+      require 'sisimai/lhost'
+
+      # https://www.courier-mta.org/courierdsn.html
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r<^Content-Type:[ ](?:message/rfc822|text/rfc822-headers)>.freeze
+      StartingOf = {
+        # courier/module.dsn/dsn*.txt
+        message: ['DELAYS IN DELIVERING YOUR MESSAGE', 'UNDELIVERABLE MAIL'],
+      }.freeze
+
+      MessagesOf = {
+        # courier/module.esmtp/esmtpclient.c:526| hard_error(del, ctf, "No such domain.");
+        'hostunknown'  => ['No such domain.'],
+        # courier/module.esmtp/esmtpclient.c:531| hard_error(del, ctf,
+        # courier/module.esmtp/esmtpclient.c:532|  "This domain's DNS violates RFC 1035.");
+        'systemerror'  => ["This domain's DNS violates RFC 1035."],
+        # courier/module.esmtp/esmtpclient.c:535| soft_error(del, ctf, "DNS lookup failed.");
+        'networkerror' => ['DNS lookup failed.'],
+      }.freeze
+
+      # Parse bounce messages from Courier MTA
+      # @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)
+        match  = 0
+        match += 1 if mhead['from'].include?('Courier mail server at ')
+        match += 1 if mhead['subject'] =~ /(?:NOTICE: mail delivery status[.]|WARNING: delayed mail[.])/
+        if mhead['message-id']
+          # Message-ID: <courier.4D025E3A.00001792@5jo.example.org>
+          match += 1 if mhead['message-id'] =~ /\A[<]courier[.][0-9A-F]+[.]/
+        end
+        return nil unless match > 0
+
+        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")
+        readslices = ['']
+        readcursor = 0      # (Integer) Points the current cursor position
+        recipients = 0      # (Integer) The number of 'Final-Recipient' header
+        commandtxt = ''     # (String) SMTP Command name begin with the string '>>>'
+        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.
+          readslices << e # Save the current line for the next loop
+
+          if readcursor == 0
+            # Beginning of the bounce message or message/delivery-status part
+            if e.include?(StartingOf[:message][0]) || e.include?(StartingOf[:message][1])
+              readcursor |= Indicators[:deliverystatus]
+              next
+            end
+          end
+          next if (readcursor & Indicators[:deliverystatus]) == 0
+          next if e.empty?
+
+          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
+            if cv = e.match(/\A[>]{3}[ ]+([A-Z]{4})[ ]?/)
+              # Your message to the following recipients cannot be delivered:
+              #
+              # <kijitora@example.co.jp>:
+              #    mx.example.co.jp [74.207.247.95]:
+              # >>> RCPT TO:<kijitora@example.co.jp>
+              # <<< 550 5.1.1 <kijitora@example.co.jp>... User Unknown
+              #
+              next unless commandtxt.empty?
+              commandtxt = cv[1]
+            else
+              # Continued line of the value of Diagnostic-Code field
+              next unless readslices[-2].start_with?('Diagnostic-Code:')
+              next unless cv = e.match(/\A[ \t]+(.+)\z/)
+              v['diagnosis'] << ' ' << cv[1]
+              readslices[-1] = 'Diagnostic-Code: ' << e
+            end
+          end
+        end
+        return nil unless recipients > 0
+
+        dscontents.each do |e|
+          # Set default values if each value is empty.
+          permessage.each_key { |a| e[a] ||= permessage[a] || '' }
+          e['command'] ||= commandtxt || ''
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis']) || ''
+
+          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 'Courier MTA'; end
+    end
+  end
+end
+

data/lib/sisimai/lhost/domino.rb

@@ -0,0 +1,118 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::Domino parses a bounce email which created by IBM
+  # Domino Server. Methods in the module are called from only Sisimai::Message.
+  module Domino
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/Domino.pm
+      require 'sisimai/lhost'
+
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r|^Content-Type:[ ]message/delivery-status|.freeze
+      StartingOf = { message: ['Your message'] }.freeze
+      MessagesOf = {
+        'userunknown' => [
+          'not listed in Domino Directory',
+          'not listed in public Name & Address Book',
+          'Domino ディレクトリには見つかりません',
+        ],
+        'filtered' => ['Cannot route mail to user'],
+        'systemerror' => ['Several matches found in Domino Directory'],
+      }.freeze
+
+      # Parse bounce messages from IBM Domino Server
+      # @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['subject'].start_with?('DELIVERY FAILURE:')
+
+        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
+        subjecttxt = ''     # (String) The value of Subject:
+        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.
+          next if e.empty?
+
+          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
+
+          # Your message
+          #
+          #   Subject: Test Bounce
+          #
+          # was not delivered to:
+          #
+          #   kijitora@example.net
+          #
+          # because:
+          #
+          #   User some.name (kijitora@example.net) not listed in Domino Directory
+          #
+          v = dscontents[-1]
+
+          if e.start_with?('was not delivered to:')
+            # was not delivered to:
+            if v['recipient']
+              # There are multiple recipient addresses in the message body.
+              dscontents << Sisimai::Lhost.DELIVERYSTATUS
+              v = dscontents[-1]
+            end
+            v['recipient'] ||= e
+            recipients += 1
+
+          elsif cv = e.match(/\A[ ][ ]([^ ]+[@][^ ]+)\z/)
+            # Continued from the line "was not delivered to:"
+            #   kijitora@example.net
+            v['recipient'] = Sisimai::Address.s3s4(cv[1])
+
+          elsif e.start_with?('because:')
+            # because:
+            v['diagnosis'] = e
+          else
+            if v['diagnosis'].to_s == 'because:'
+              # Error message, continued from the line "because:"
+              v['diagnosis'] = e
+
+            elsif cv = e.match(/\A[ ][ ]Subject: (.+)\z/)
+              #   Subject: Nyaa
+              subjecttxt = cv[1]
+            end
+          end
+        end
+        return nil unless recipients > 0
+
+        dscontents.each do |e|
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+          e['recipient'] = Sisimai::Address.s3s4(e['recipient'])
+
+          MessagesOf.each_key do |r|
+            # Check each regular expression of Domino error messages
+            next unless MessagesOf[r].any? { |a| e['diagnosis'].include?(a) }
+            e['reason'] = r
+            e['status'] = Sisimai::SMTP::Status.code(r.to_s, false) || ''
+            break
+          end
+        end
+
+        # Set the value of subjecttxt as a Subject if there is no original
+        # message in the bounce mail.
+        emailsteak[1] << ('Subject: ' << subjecttxt << "\n") unless emailsteak[1] =~ /^Subject: /
+
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'IBM Domino Server'; end
+    end
+  end
+end
+