sisimai 4.21.1 → 4.22.0

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

@@ -0,0 +1,174 @@
+module Sisimai::Bite::Email
+  module Domino
+    # Sisimai::Bite::Email::Domino parses a bounce email which created by IBM
+    # Domino Server. Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/Domino.pm
+      require 'sisimai/bite/email'
+
+      Re0 = {
+        :subject => %r/\ADELIVERY FAILURE:/,
+      }
+      Re1 = {
+        :begin   => %r/\AYour message/,
+        :rfc822  => %r|\AContent-Type: message/delivery-status\z|,
+        :endof   => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      ReFailure = {
+        userunknown: %r{(?>
+           not[ ]listed[ ]in[ ](?:
+             Domino[ ]Directory
+            |public[ ]Name[ ][&][ ]Address[ ]Book
+            )
+          |Domino[ ]ディレクトリには見つかりません
+          )
+        }x,
+        filtered:    %r/Cannot[ ]route[ ]mail[ ]to[ ]user/x,
+        systemerror: %r/Several[ ]matches[ ]found[ ]in[ ]Domino[ ]Directory/x,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'IBM Domino Server'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def headerlist;  return []; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from IBM Domino Server
+      # @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['subject'] =~ Re0[:subject]
+
+        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
+        subjecttxt = ''     # (String) The value of Subject:
+        v = nil
+
+        hasdivided.each do |e|
+          next if e.empty?
+
+          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
+
+            # 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 =~ /\Awas not delivered to:\z/
+              # was not delivered to:
+              if v['recipient']
+                # There are multiple recipient addresses in the message body.
+                dscontents << Sisimai::Bite.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 =~ /\Abecause:\z/
+              # because:
+              v['diagnosis'] = e
+
+            else
+
+              if v['diagnosis'] && v['diagnosis'] == '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
+        end
+
+        return nil if recipients.zero?
+        require 'sisimai/string'
+        require 'sisimai/smtp/status'
+
+        dscontents.map do |e|
+          e['agent']     = self.smtpagent
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+          e['recipient'] = Sisimai::Address.s3s4(e['recipient'])
+
+          ReFailure.each_key do |r|
+            # Check each regular expression of Domino error messages
+            next unless e['diagnosis'] =~ ReFailure[r]
+            e['reason'] = r.to_s
+            pseudostatus = Sisimai::SMTP::Status.code(r.to_s, false)
+            e['status'] = pseudostatus if pseudostatus.size > 0
+            break
+          end
+          e.each_key { |a| e[a] ||= '' }
+        end
+
+        unless rfc822list.find { |a| a =~ /^Subject:/ }
+          # Set the value of $subjecttxt as a Subject if there is no original
+          # message in the bounce mail.
+          rfc822list << sprintf('Subject: %s', subjecttxt)
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end
+

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

@@ -0,0 +1,143 @@
+module Sisimai::Bite::Email
+  module EinsUndEins
+    # Sisimai::Bite::Email::EinsUndEins parses a bounce email which created by
+    # 1&1. Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/EinsUndEins.pm
+      require 'sisimai/bite/email'
+
+      Re0 = {
+        :from    => %r/\A["]Mail Delivery System["]/,
+        :subject => %r/\AMail delivery failed: returning message to sender\z/,
+      }
+      Re1 = {
+        :begin   => %r/\AThis message was created automatically by mail delivery software/,
+        :error   => %r/\AFor the following reason:/,
+        :rfc822  => %r/\A--- The header of the original message is following/,
+        :endof   => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      ReFailure = {
+        mesgtoobig: %r/Mail[ ]size[ ]limit[ ]exceeded/x,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return '1&1: http://www.1and1.de'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      # X-UI-Out-Filterresults: unknown:0;
+      def headerlist;  return []; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from 1&1
+      # @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]
+
+        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 address failed:
+            #
+            # general@example.eu
+            #
+            # For the following reason:
+            #
+            # Mail size limit exceeded. For explanation visit
+            # http://postmaster.1and1.com/en/error-messages?ip=%1s
+            v = dscontents[-1]
+
+            if cv = e.match(/\A([^ ]+[@][^ ]+)\z/)
+              # general@example.eu
+              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 e =~ Re1[:error]
+              # For the following reason:
+              v['diagnosis'] = e
+
+            else
+              # Get error message
+              if v['diagnosis']
+                # Append error message strings
+                v['diagnosis'] += ' ' + e
+              end
+            end
+          end
+        end
+        return nil if recipients.zero?
+        require 'sisimai/string'
+
+        dscontents.map do |e|
+          e['agent']       = self.smtpagent
+          e['diagnosis'] ||= ''
+          e['diagnosis']   = e['diagnosis'].gsub(/\A#{Re1[:error]}/, '')
+          e['diagnosis']   = Sisimai::String.sweep(e['diagnosis'])
+
+          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
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end
+

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

@@ -0,0 +1,284 @@
+module Sisimai::Bite::Email
+  module Exchange2003
+    # Sisimai::Bite::Email::Exchange2003 parses a bounce email which created by
+    # Microsoft Exchange Server 2003.
+    # Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/Exchange2003.pm
+      require 'sisimai/bite/email'
+
+      Re0 = {
+        # X-Mailer: Internet Mail Service (5.0.1461.28)
+        # X-Mailer: Microsoft Exchange Server Internet Mail Connector Version ...
+        :'x-mailer'  => %r{\A(?:
+           Internet[ ]Mail[ ]Service[ ][(][\d.]+[)]\z
+          |Microsoft[ ]Exchange[ ]Server[ ]Internet[ ]Mail[ ]Connector
+          )
+        }x,
+        :'x-mimeole' => %r/\AProduced By Microsoft Exchange/,
+        # Received: by ***.**.** with Internet Mail Service (5.5.2657.72)
+        :'received'  => %r/\Aby .+ with Internet Mail Service [(][\d.]+[)]/,
+      }
+      Re1 = {
+        :begin  => %r/\AYour message/,
+        :error  => %r/\Adid not reach the following recipient[(]s[)]:/,
+        :rfc822 => %r|\AContent-Type: message/rfc822|,
+        :endof  => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      CodeTable = {
+        onhold: [
+          '000B099C', # Host Unknown, Message exceeds size limit, ...
+          '000B09AA', # Unable to relay for, Message exceeds size limit,...
+          '000B09B6', # Error messages by remote MTA
+        ],
+        userunknown: [
+          '000C05A6', # Unknown Recipient,
+        ],
+        systemerror: [
+          '00010256', # Too many recipients.
+          '000D06B5', # No proxy for recipient (non-smtp mail?)
+        ],
+        networkerror: [
+          '00120270', # Too Many Hops
+        ],
+        contenterr: [
+          '00050311', # Conversion to Internet format failed
+          '000502CC', # Conversion to Internet format failed
+        ],
+        securityerr: [
+          '000B0981', # 502 Server does not support AUTH
+        ],
+        filtered: [
+          '000C0595', # Ambiguous Recipient
+        ],
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'Microsoft Exchange Server 2003'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def headerlist;  return ['X-MS-Embedded-Report', 'X-MimeOLE']; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from Microsoft Exchange Server 2003
+      # @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['x-ms-embedded-report']
+        catch :EXCHANGE_OR_NOT do
+          loop do
+            throw :EXCHANGE_OR_NOT if match > 0
+
+            if mhead['x-mailer']
+              # X-Mailer:  Microsoft Exchange Server Internet Mail Connector Version 4.0.994.63
+              # X-Mailer: Internet Mail Service (5.5.2232.9)
+              match += 1 if mhead['x-mailer'] =~ Re0[:'x-mailer']
+              throw :EXCHANGE_OR_NOT if match > 0
+            end
+
+            if mhead['x-mimeole']
+              # X-MimeOLE: Produced By Microsoft Exchange V6.5
+              match += 1 if mhead['x-mimeole'] =~ Re0[:'x-mimeole']
+              throw :EXCHANGE_OR_NOT if match > 0
+            end
+
+            throw :EXCHANGE_OR_NOT if mhead['received'].size.zero?
+            mhead['received'].each do |e|
+              # Received: by ***.**.** with Internet Mail Service (5.5.2657.72)
+              next unless e =~ Re0[:'received']
+              match += 1
+              throw :EXCHANGE_OR_NOT
+            end
+            break
+          end
+        end
+        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
+        statuspart = false  # (Boolean) Flag, true = have got delivery status part.
+        connvalues = 0      # (Integer) Flag, 1 if all the value of $connheader have been set
+        connheader = {
+          'to'      => '',  # The value of "To"
+          'date'    => '',  # The value of "Date"
+          'subject' => '',  # The value of "Subject"
+        }
+        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 statuspart
+
+            if connvalues == connheader.keys.size
+              # did not reach the following recipient(s):
+              #
+              # kijitora@example.co.jp on Thu, 29 Apr 2007 16:51:51 -0500
+              #     The recipient name is not recognized
+              #     The MTS-ID of the original message is: c=jp;a= ;p=neko
+              # ;l=EXCHANGE000000000000000000
+              #     MSEXCH:IMS:KIJITORA CAT:EXAMPLE:EXCHANGE 0 (000C05A6) Unknown Recipient
+              # mikeneko@example.co.jp on Thu, 29 Apr 2007 16:51:51 -0500
+              #     The recipient name is not recognized
+              #     The MTS-ID of the original message is: c=jp;a= ;p=neko
+              # ;l=EXCHANGE000000000000000000
+              #     MSEXCH:IMS:KIJITORA CAT:EXAMPLE:EXCHANGE 0 (000C05A6) Unknown Recipient
+              v = dscontents[-1]
+
+              if cv = e.match(/\A[ \t]*([^ ]+[@][^ ]+) on[ \t]*.*\z/) ||
+                      e.match(/\A[ \t]*.+(?:SMTP|smtp)=([^ ]+[@][^ ]+) on[ \t]*.*\z/)
+                # kijitora@example.co.jp on Thu, 29 Apr 2007 16:51:51 -0500
+                #   kijitora@example.com on 4/29/99 9:19:59 AM
+                if v['recipient']
+                  # There are multiple recipient addresses in the message body.
+                  dscontents << Sisimai::Bite.DELIVERYSTATUS
+                  v = dscontents[-1]
+                end
+                v['recipient'] = cv[1]
+                v['msexch'] = false
+                recipients += 1
+
+              elsif cv = e.match(/\A[ \t]+(MSEXCH:.+)\z/)
+                #     MSEXCH:IMS:KIJITORA CAT:EXAMPLE:EXCHANGE 0 (000C05A6) Unknown Recipient
+                v['diagnosis'] ||= ''
+                v['diagnosis']  += cv[1]
+
+              else
+                next if v['msexch']
+                if v['diagnosis'] =~ /\AMSEXCH:.+/
+                  # Continued from MEEXCH in the previous line
+                  v['msexch'] = true
+                  v['diagnosis'] ||= ''
+                  v['diagnosis']  += ' ' + e
+                  statuspart = true
+
+                else
+                  # Error message in the body part
+                  v['alterrors'] ||= ''
+                  v['alterrors']  += ' ' + e
+                end
+              end
+
+            else
+              # Your message
+              #
+              #  To:      shironeko@example.jp
+              #  Subject: ...
+              #  Sent:    Thu, 29 Apr 2010 18:14:35 +0000
+              #
+              if cv = e.match(/\A[ \t]+To:[ \t]+(.+)\z/)
+                #  To:      shironeko@example.jp
+                next if connheader['to'].size > 0
+                connheader['to'] = cv[1]
+                connvalues += 1
+
+              elsif cv = e.match(/\A[ \t]+Subject:[ \t]+(.+)\z/)
+                #  Subject: ...
+                next if connheader['subject'].size > 0
+                connheader['subject'] = cv[1]
+                connvalues += 1
+
+              elsif cv = e.match(%r|\A[ \t]+Sent:[ \t]+([A-Z][a-z]{2},.+[-+]\d{4})\z|) ||
+                    cv = e.match(%r|\A[ \t]+Sent:[ \t]+(\d+[/]\d+[/]\d+[ \t]+\d+:\d+:\d+[ \t].+)|)
+                #  Sent:    Thu, 29 Apr 2010 18:14:35 +0000
+                #  Sent:    4/29/99 9:19:59 AM
+                next if connheader['date'].size > 0
+                connheader['date'] = cv[1]
+                connvalues += 1
+              end
+            end
+          end
+        end
+
+        return nil if recipients.zero?
+        require 'sisimai/string'
+        require 'sisimai/smtp/status'
+
+        dscontents.map do |e|
+          if cv = e['diagnosis'].match(/\AMSEXCH:.+[ \t]*[(]([0-9A-F]{8})[)][ \t]*(.*)\z/)
+            #     MSEXCH:IMS:KIJITORA CAT:EXAMPLE:EXCHANGE 0 (000C05A6) Unknown Recipient
+            capturedcode = cv[1]
+            errormessage = cv[2]
+            pseudostatus = ''
+
+            CodeTable.each_key do |r|
+              # Find captured code from the error code table
+              next unless CodeTable[r].index(capturedcode)
+              e['reason'] = r.to_s
+              pseudostatus = Sisimai::SMTP::Status.code(r.to_s)
+              e['status'] = pseudostatus if pseudostatus.size > 0
+              break
+            end
+            e['diagnosis'] = errormessage
+          end
+
+          unless e['reason']
+            # Could not detect the reason from the value of "diagnosis".
+            if e['alterrors']
+              # Copy alternative error message
+              e['diagnosis'] = e['alterrors'] + ' ' + e['diagnosis']
+              e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+              e.delete('alterrors')
+            end
+          end
+          e['agent'] = self.smtpagent
+          e.delete('msexch')
+          e.each_key { |a| e[a] ||= '' }
+        end
+
+        if rfc822list.empty?
+          # When original message does not included in the bounce message
+          rfc822list << sprintf('From: %s', connheader['to'])
+          rfc822list << sprintf('Date: %s', connheader['date'])
+          rfc822list << sprintf('Subject: %s', connheader['subject'])
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end
+