sisimai 4.25.3 → 4.25.8

data/lib/sisimai/{bite/email → lhost}/mxlogic.rb

@@ -1,19 +1,16 @@
-module Sisimai::Bite::Email
-  # Sisimai::Bite::Email::MXLogic parses a bounce email which created by
+module Sisimai::Lhost
+  # Sisimai::Lhost::MXLogic parses a bounce email which created by
   # McAfee SaaS (formerly MX Logic).
   # Methods in the module are called from only Sisimai::Message.
   module MXLogic
     class << self
-      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/MXLogic.pm
-      # Based on Sisimai::Bite::Email::Exim
-      require 'sisimai/bite/email'
-
-      Indicators = Sisimai::Bite::Email.INDICATORS
-      StartingOf = {
-        message: ['This message was created automatically by mail delivery software.'],
-        rfc822:  ['Included is a copy of the message header:'],
-      }.freeze
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/MXLogic.pm
+      # Based on Sisimai::Lhost::Exim
+      require 'sisimai/lhost'
 
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r|^Included is a copy of the message header:|.freeze
+      StartingOf = { message: ['This message was created automatically by mail delivery software.'] }.freeze
       ReCommands = [
         %r/SMTP error from remote (?:mail server|mailer) after ([A-Za-z]{4})/,
         %r/SMTP error from remote (?:mail server|mailer) after end of ([A-Za-z]{4})/,
@@ -72,26 +69,15 @@ module Sisimai::Bite::Email
         'was frozen on arrival by ',
       ].freeze
 
-      def description; return 'McAfee SaaS'; end
-      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
-      # X-MX-Bounce: mta/src/queue/bounce
-      # X-MXL-NoteHash: ffffffffffffffff-0000000000000000000000000000000000000000
-      # X-MXL-Hash: 4c9d4d411993da17-bbd4212b6c887f6c23bab7db4bd87ef5edc00758
-      def headerlist;  return %w[x-mxl-notehash x-mxl-hash x-mx-bounce]; end
-
       # Parse bounce messages from MXLogic
-      # @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)
-        # :'message-id' => %r/\A[<]mxl[~][0-9a-f]+/,
+      # @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-MX-Bounce: mta/src/queue/bounce
+        # X-MXL-NoteHash: ffffffffffffffff-0000000000000000000000000000000000000000
+        # X-MXL-Hash: 4c9d4d411993da17-bbd4212b6c887f6c23bab7db4bd87ef5edc00758
         match  = 0
         match += 1 if mhead['x-mx-bounce']
         match += 1 if mhead['x-mxl-hash']
@@ -105,74 +91,53 @@ module Sisimai::Bite::Email
         }x
         return nil unless match > 0
 
-        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
+        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
         localhost0 = ''     # (String) Local MTA
         v = nil
 
-        while e = hasdivided.shift do
+        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
-            if e == StartingOf[:message][0]
-              readcursor |= Indicators[:deliverystatus]
-              next
-            end
+            readcursor |= Indicators[:deliverystatus] if e == StartingOf[:message][0]
+            next
           end
-
-          if (readcursor & Indicators[:'message-rfc822']) == 0
-            # Beginning of the original message part
-            if e == StartingOf[:rfc822][0]
-              readcursor |= Indicators[:'message-rfc822']
-              next
+          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(es) failed:
+          #
+          #  kijitora@example.jp
+          #    SMTP error from remote mail server after RCPT TO:<kijitora@example.jp>:
+          #    host neko.example.jp [192.0.2.222]: 550 5.1.1 <kijitora@example.jp>... User Unknown
+          v = dscontents[-1]
+
+          if cv = e.match(/\A[ \t]*[<]([^ ]+[@][^ ]+)[>]:(.+)\z/)
+            # A message that you have sent could not be delivered to one or more
+            # recipients.  This is a permanent error.  The following address failed:
+            #
+            #  <kijitora@example.co.jp>: 550 5.1.1 ...
+            if v['recipient']
+              # There are multiple recipient addresses in the message body.
+              dscontents << Sisimai::Lhost.DELIVERYSTATUS
+              v = dscontents[-1]
             end
-          end
+            v['recipient'] = cv[1]
+            v['diagnosis'] = cv[2]
+            recipients += 1
 
-          if readcursor & Indicators[:'message-rfc822'] > 0
-            # Inside of the original message part
-            if e.empty?
-              blanklines += 1
-              break if blanklines > 1
-              next
-            end
-            rfc822list << e
-          else
-            # Error message part
-            next if (readcursor & Indicators[:deliverystatus]) == 0
+          elsif dscontents.size == recipients
+            # Error message
             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(es) failed:
-            #
-            #  kijitora@example.jp
-            #    SMTP error from remote mail server after RCPT TO:<kijitora@example.jp>:
-            #    host neko.example.jp [192.0.2.222]: 550 5.1.1 <kijitora@example.jp>... User Unknown
-            v = dscontents[-1]
-
-            if cv = e.match(/\A[ \t]*[<]([^ ]+[@][^ ]+)[>]:(.+)\z/)
-              # A message that you have sent could not be delivered to one or more
-              # recipients.  This is a permanent error.  The following address failed:
-              #
-              #  <kijitora@example.co.jp>: 550 5.1.1 ...
-              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['diagnosis'] = cv[2]
-              recipients += 1
-
-            elsif dscontents.size == recipients
-              # Error message
-              next if e.empty?
-              v['diagnosis'] << e + ' '
-            end
+            v['diagnosis'] << e + ' '
           end
         end
         return nil unless recipients > 0
@@ -184,7 +149,6 @@ module Sisimai::Bite::Email
         end
 
         dscontents.each do |e|
-          e['agent'] = self.smtpagent
           e['lhost'] = localhost0
           e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'].gsub(/[-]{2}.*\z/, ''))
 
@@ -232,13 +196,11 @@ module Sisimai::Bite::Email
               end
             end
           end
-          e.each_key { |a| e[a] ||= '' }
         end
 
-        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
-        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
       end
-
+      def description; return 'McAfee SaaS'; end
     end
   end
 end

data/lib/sisimai/lhost/notes.rb

@@ -0,0 +1,126 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::Notes parses a bounce email which created by Lotus
+  # Notes Server. Methods in the module are called from only Sisimai::Message.
+  module Notes
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/Notes.pm
+      require 'sisimai/lhost'
+
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r|^-------[ ]Returned[ ]Message[ ]--------|.freeze
+      StartingOf = { message: ['------- Failure Reasons '] }.freeze
+      MessagesOf = {
+        'userunknown' => [
+          'User not listed in public Name & Address Book',
+          'ディレクトリのリストにありません',
+        ],
+        networkerror: ['Message has exceeded maximum hop count'],
+      }.freeze
+
+      # Parse bounce messages from Lotus Notes
+      # @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?('Undeliverable message')
+
+        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
+        characters = ''     # (String) Character set name of the bounce mail
+        removedmsg = 'MULTIBYTE CHARACTERS HAVE BEEN REMOVED'
+        encodedmsg = ''
+        v = nil
+
+        if cv = mhead['content-type'].match(/\A.+;[ ]*charset=(.+)\z/)
+          # Get character set name
+          # Content-Type: text/plain; charset=ISO-2022-JP
+          characters = cv[1].downcase
+        end
+
+        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
+
+          # ------- Failure Reasons  --------
+          #
+          # User not listed in public Name & Address Book
+          # kijitora@notes.example.jp
+          #
+          # ------- Returned Message --------
+          v = dscontents[-1]
+          if e =~ /\A[^ ]+[@][^ ]+/
+            # kijitora@notes.example.jp
+            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
+          else
+            next if e.empty?
+            next if e.start_with?('-')
+
+            if e =~ /[^\x20-\x7e]/
+              # Error message is not ISO-8859-1
+              if characters.size > 0
+                # Try to convert string
+                begin
+                  encodedmsg = e.encode('UTF-8', characters)
+                rescue
+                  # Failed to convert
+                  encodedmsg = removedmsg
+                end
+              else
+                # No character set in Content-Type header
+                encodedmsg = removedmsg
+              end
+              v['diagnosis'] ||= ''
+              v['diagnosis'] << encodedmsg
+            else
+              # Error message does not include multi-byte character
+              v['diagnosis'] ||= ''
+              v['diagnosis'] << e
+            end
+          end
+        end
+
+        unless recipients > 0
+          # Fallback: Get the recpient address from RFC822 part
+          if cv = emailsteak[1].match(/^To:[ ]*(.+)$/)
+            v['recipient'] = Sisimai::Address.s3s4(cv[1])
+            recipients += 1 unless v['recipient'].empty?
+          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 Notes error messages
+            next unless MessagesOf[r].any? { |a| e['diagnosis'].include?(a) }
+            e['reason'] = r
+            e['status'] = Sisimai::SMTP::Status.code(r.to_s) || ''
+            break
+          end
+        end
+
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'Lotus Notes'; end
+    end
+  end
+end
+

data/lib/sisimai/lhost/office365.rb

@@ -0,0 +1,216 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::Office365 parses a bounce email which created by
+  # Microsoft Office 365.
+  # Methods in the module are called from only Sisimai::Message.
+  module Office365
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/Office365.pm
+      require 'sisimai/lhost'
+
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r|^Content-Type:[ ]message/rfc822|.freeze
+      StartingOf = {
+        error:  ['Diagnostic information for administrators:'],
+        eoerr:  ['Original message headers:'],
+      }.freeze
+      MarkingsOf = {
+        eoe:     %r/\A(?:Original[ ][Mm]essage[ ][Hh]eaders:?|Message[ ]Hops)/,
+        error:   %r/\A(?:Diagnostic[ ]information[ ]for[ ]administrators:|Error[ ]Details)/,
+        message: %r{\A(?:
+           Delivery[ ]has[ ]failed[ ]to[ ]these[ ]recipients[ ]or[ ]groups:
+          |Original[ ]Message[ ]Details
+          |.+[ ]rejected[ ]your[ ]message[ ]to[ ]the[ ]following[ ]e[-]?mail[ ]addresses:
+          )
+        }x,
+      }.freeze
+      Headers365 = %w[
+        x-ms-exchange-message-is-ndr
+        x-microsoft-antispam-prvs
+        x-exchange-antispam-report-test
+        x-exchange-antispam-report-cfa-test
+        x-ms-exchange-crosstenant-originalarrivaltime
+        x-ms-exchange-crosstenant-fromentityheader
+        x-ms-exchange-transport-crosstenantheadersstamped
+      ]
+      StatusList = {
+        # https://support.office.com/en-us/article/Email-non-delivery-reports-in-Office-365-51daa6b9-2e35-49c4-a0c9-df85bf8533c3
+        %r/\A4[.]4[.]7\z/        => 'expired',
+        %r/\A4[.]4[.]312\z/      => 'networkerror',
+        %r/\A4[.]4[.]316\z/      => 'expired',
+        %r/\A4[.]7[.]26\z/       => 'securityerror',
+        %r/\A4[.]7[.][56]\d\d\z/ => 'blocked',
+        %r/\A4[.]7[.]8[5-9]\d\z/ => 'blocked',
+        %r/\A5[.]0[.]350\z/      => 'contenterror',
+        %r/\A5[.]1[.]10\z/       => 'userunknown',
+        %r/\A5[.]4[.]1\z/        => 'norelaying',
+        %r/\A5[.]4[.]312\z/      => 'networkerror',
+        %r/\A5[.]4[.]316\z/      => 'expired',
+        %r/\A5[.]4[.]6\z/        => 'networkerror',
+        %r/\A5[.]6[.]11\z/       => 'contenterror',
+        %r/\A5[.]7[.]1\z/        => 'rejected',
+        %r/\A5[.]7[.]1[23]\z/    => 'rejected',
+        %r/\A5[.]7[.]124\z/      => 'rejected',
+        %r/\A5[.]7[.]13[3-6]\z/  => 'rejected',
+        %r/\A5[.]7[.]23\z/       => 'blocked',
+        %r/\A5[.]7[.]25\z/       => 'networkerror',
+        %r/\A5[.]7[.]50[1-3]\z/  => 'spamdetected',
+        %r/\A5[.]7[.]50[4-5]\z/  => 'filtered',
+        %r/\A5[.]7[.]50[6-7]\z/  => 'blocked',
+        %r/\A5[.]7[.]508\z/      => 'toomanyconn',
+        %r/\A5[.]7[.]509\z/      => 'securityerror',
+        %r/\A5[.]7[.]510\z/      => 'notaccept',
+        %r/\A5[.]7[.]511\z/      => 'rejected',
+        %r/\A5[.]7[.]512\z/      => 'securityerror',
+        %r/\A5[.]7[.]57\z/       => 'securityerror',
+        %r/\A5[.]7[.]60[6-9]\z/  => 'blocked',
+        %r/\A5[.]7[.]6[1-4]\d\z/ => 'blocked',
+        %r/\A5[.]7[.]7[0-4]\d\z/ => 'toomanyconn',
+      }.freeze
+      ReCommands = {
+        RCPT: %r/unknown recipient or mailbox unavailable ->.+[<]?.+[@].+[.][a-zA-Z]+[>]?/,
+      }.freeze
+
+      # Parse bounce messages from Microsoft Office 365
+      # @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-MS-Exchange-Message-Is-Ndr:
+        # X-Microsoft-Antispam-PRVS: <....@...outlook.com>
+        # X-Exchange-Antispam-Report-Test: UriScan:;
+        # X-Exchange-Antispam-Report-CFA-Test:
+        # X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 Apr 2015 23:34:45.6789 (JST)
+        # X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
+        # X-MS-Exchange-Transport-CrossTenantHeadersStamped: ...
+        tryto  = %r/.+[.](?:outbound[.]protection|prod)[.]outlook[.]com\b/
+        match  = 0
+        match += 1 if mhead['subject'].include?('Undeliverable:')
+        Headers365.each do |e|
+          next if mhead[e].nil?
+          next if mhead[e].empty?
+          match += 1
+        end
+        match += 1 if mhead['received'].any? { |a| a =~ tryto }
+        if mhead['message-id']
+          # Message-ID: <00000000-0000-0000-0000-000000000000@*.*.prod.outlook.com>
+          match += 1 if mhead['message-id'] =~ tryto
+        end
+        return nil if match < 2
+
+        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
+        connheader = {}
+        endoferror = false  # (Boolean) Flag for the end of error messages
+        htmlbegins = false  # (Boolean) Flag for HTML part
+        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 =~ MarkingsOf[:message]
+            next
+          end
+          next if (readcursor & Indicators[:deliverystatus]) == 0
+          next if e.empty?
+
+          # kijitora@example.com<mailto:kijitora@example.com>
+          # The email address wasn't found at the destination domain. It might
+          # be misspelled or it might not exist any longer. Try retyping the
+          # address and resending the message.
+          #
+          # Original Message Details
+          # Created Date:   4/29/2017 6:40:30 AM
+          # Sender Address: neko@example.jp
+          # Recipient Address:      kijitora@example.org
+          # Subject:        Nyaan#
+          v = dscontents[-1]
+
+          if cv = e.match(/\A.+[@].+[<]mailto:(.+[@].+)[>]\z/) ||
+                  e.match(/\ARecipient[ ]Address:[ ]+(.+)\z/)
+            # kijitora@example.com<mailto: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
+
+          elsif cv = e.match(/\AGenerating server: (.+)\z/)
+            # Generating server: FFFFFFFFFFFF.e0.prod.outlook.com
+            connheader['lhost'] = cv[1].downcase
+          else
+            if endoferror
+              # After "Original message headers:"
+              next unless f = Sisimai::RFC1894.match(e)
+              next unless o = Sisimai::RFC1894.field(e)
+              next unless fieldtable[o[0]]
+              next if o[0] =~ /\A(?:diagnostic-code|final-recipient)\z/
+              v[fieldtable[o[0]]] = o[2]
+
+              next unless f == 1
+              permessage[fieldtable[o[0]]] = o[2]
+            else
+              if e =~ MarkingsOf[:error]
+                # Diagnostic information for administrators:
+                v['diagnosis'] = e
+              else
+                # kijitora@example.com
+                # Remote Server returned '550 5.1.10 RESOLVER.ADR.RecipientNotFound; Recipien=
+                # t not found by SMTP address lookup'
+                next unless v['diagnosis']
+                if e =~ MarkingsOf[:eoe]
+                  # Original message headers:
+                  endoferror = true
+                  next
+                end
+                v['diagnosis'] << ' ' << e
+              end
+            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['status']  ||= ''
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis']) || ''
+          if e['status'].empty? || e['status'].end_with?('.0.0')
+            # There is no value of Status header or the value is 5.0.0, 4.0.0
+            e['status'] = Sisimai::SMTP::Status.find(e['diagnosis']) || ''
+          end
+
+          ReCommands.each_key do |p|
+            # Try to match with regular expressions defined in ReCommands
+            next unless e['diagnosis'] =~ ReCommands[p]
+            e['command'] = p.to_s
+            break
+          end
+          next unless e['status']
+
+          StatusList.each_key do |f|
+            # Try to match with each key as a regular expression
+            next unless e['status'] =~ f
+            e['reason'] = StatusList[f]
+            break
+          end
+        end
+
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'Microsoft Office 365: https://office.microsoft.com/'; end
+    end
+  end
+end
+