sisimai 5.0.3 → 5.2.0

data/lib/sisimai/lhost/exchange2007.rb

@@ -1,5 +1,6 @@
 module Sisimai::Lhost
-  # Sisimai::Lhost::Exchange2007 parses a bounce email which created by Microsoft Exchange Server 2007.
+  # Sisimai::Lhost::Exchange2007 decodes a bounce email which created by Microsoft Exchange Server
+  # 2007 https://www.microsoft.com/microsoft-365/exchange/email.
   # Methods in the module are called from only Sisimai::Message.
   module Exchange2007
     class << self
@@ -7,156 +8,166 @@ module Sisimai::Lhost
 
       Indicators = Sisimai::Lhost.INDICATORS
       Boundaries = [
-        'Original message headers:',                # en-US
+        "Original Message Headers",
+        "Original message headers:",                # en-US
         "tes de message d'origine :",               # fr-FR/En-têtes de message d'origine
-        'Intestazioni originali del messaggio:',    # it-CH
+        "Intestazioni originali del messaggio:",    # it-CH
+        "Ursprungshuvuden:",                        # sv-SE
       ].freeze
-      MarkingsOf = {
+      StartingOf = {
+        error:   [" RESOLVER.", " QUEUE."],
         message: [
-          'Diagnostic information for administrators:',           # en-US
-          'Informations de diagnostic pour les administrateurs',  # fr-FR
-          'Informazioni di diagnostica per gli amministratori',   # it-CH
+          "Error Details",
+          "Diagnostic information for administrators:",           # en-US
+          "Informations de diagnostic pour les administrateurs",  # fr-FR
+          "Informazioni di diagnostica per gli amministratori",   # it-CH
+          "Diagnostisk information f",                            # sv-SE
         ],
-        error:   [' RESOLVER.', ' QUEUE.'],
         rhost:   [
-          'Generating server',        # en-US
-          'Serveur de g',             # fr-FR/Serveur de g�Hn�Hration
-          'Server di generazione',    # it-CH
+          "DSN generated by:",
+          "Generating server",        # en-US
+          "Serveur de g",             # fr-FR/Serveur de g�Hn�Hration
+          "Server di generazione",    # it-CH
+          "Genererande server",       # sv-SE
         ]
       }.freeze
       NDRSubject = {
-        'SMTPSEND.DNS.NonExistentDomain' => 'hostunknown',   # 554 5.4.4 SMTPSEND.DNS.NonExistentDomain
-        'SMTPSEND.DNS.MxLoopback'        => 'networkerror',  # 554 5.4.4 SMTPSEND.DNS.MxLoopback
-        'RESOLVER.ADR.BadPrimary'        => 'systemerror',   # 550 5.2.0 RESOLVER.ADR.BadPrimary
-        'RESOLVER.ADR.RecipNotFound'     => 'userunknown',   # 550 5.1.1 RESOLVER.ADR.RecipNotFound
-        'RESOLVER.ADR.ExRecipNotFound'   => 'userunknown',   # 550 5.1.1 RESOLVER.ADR.ExRecipNotFound
-        'RESOLVER.ADR.RecipLimit'        => 'toomanyconn',   # 550 5.5.3 RESOLVER.ADR.RecipLimit
-        'RESOLVER.ADR.InvalidInSmtp'     => 'systemerror',   # 550 5.1.0 RESOLVER.ADR.InvalidInSmtp
-        'RESOLVER.ADR.Ambiguous'         => 'systemerror',   # 550 5.1.4 RESOLVER.ADR.Ambiguous, 420 4.2.0 RESOLVER.ADR.Ambiguous
-        'RESOLVER.RST.AuthRequired'      => 'securityerror', # 550 5.7.1 RESOLVER.RST.AuthRequired
-        'RESOLVER.RST.NotAuthorized'     => 'rejected',      # 550 5.7.1 RESOLVER.RST.NotAuthorized
-        'RESOLVER.RST.RecipSizeLimit'    => 'mesgtoobig',    # 550 5.2.3 RESOLVER.RST.RecipSizeLimit
-        'QUEUE.Expired'                  => 'expired',       # 550 4.4.7 QUEUE.Expired
+        "SMTPSEND.DNS.NonExistentDomain" => "hostunknown",   # 554 5.4.4 SMTPSEND.DNS.NonExistentDomain
+        "SMTPSEND.DNS.MxLoopback"        => "networkerror",  # 554 5.4.4 SMTPSEND.DNS.MxLoopback
+        "RESOLVER.ADR.BadPrimary"        => "systemerror",   # 550 5.2.0 RESOLVER.ADR.BadPrimary
+        "RESOLVER.ADR.RecipNotFound"     => "userunknown",   # 550 5.1.1 RESOLVER.ADR.RecipNotFound
+        "RESOLVER.ADR.RecipientNotFound" => "userunknown",   # 550 5.1.1 RESOLVER.ADR.RecipientNotFound
+        "RESOLVER.ADR.ExRecipNotFound"   => "userunknown",   # 550 5.1.1 RESOLVER.ADR.ExRecipNotFound
+        "RESOLVER.ADR.RecipLimit"        => "toomanyconn",   # 550 5.5.3 RESOLVER.ADR.RecipLimit
+        "RESOLVER.ADR.InvalidInSmtp"     => "systemerror",   # 550 5.1.0 RESOLVER.ADR.InvalidInSmtp
+        "RESOLVER.ADR.Ambiguous"         => "systemerror",   # 550 5.1.4 RESOLVER.ADR.Ambiguous, 420 4.2.0 RESOLVER.ADR.Ambiguous
+        "RESOLVER.RST.AuthRequired"      => "securityerror", # 550 5.7.1 RESOLVER.RST.AuthRequired
+        "RESOLVER.RST.NotAuthorized"     => "rejected",      # 550 5.7.1 RESOLVER.RST.NotAuthorized
+        "RESOLVER.RST.RecipSizeLimit"    => "exceedlimit",   # 550 5.2.3 RESOLVER.RST.RecipSizeLimit
+        "QUEUE.Expired"                  => "expired",       # 550 4.4.7 QUEUE.Expired
       }.freeze
+      MailSender = ["postmaster@outlook.com", ".onmicrosoft.com"].freeze
+      EmailTitle = [
+        # Subject:            Content-Language:
+        "Undeliverable",    # en-US
+        "Non_remis_",       # fr-FR
+        "Non remis ",       # fr-FR
+        "Non recapitabile", # it-CH
+        "Olevererbart",     # sv-SE
+      ].freeze
 
-      # Parse bounce messages from Microsoft Exchange Server 2007
+      # @abstract Decodes the bounce message from Microsoft Exchange Server 2007
       # @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
+      # @return [Nil]           it failed to decode or the arguments are missing
       def inquire(mhead, mbody)
-        # Content-Language: en-US, fr-FR
-        match   = nil
-        match ||= 1 if mhead['subject'].start_with?('Undeliverable')
-        match ||= 1 if mhead['subject'].start_with?('Non_remis_')
-        match ||= 1 if mhead['subject'].start_with?('Non recapitabile')
-        return nil unless match
-        return nil unless mhead['content-language']
-
-        match += 1 if mhead['content-language'].size == 2 # JP
-        match += 1 if mhead['content-language'].size == 5 # ja-JP
-        return nil unless match > 1
-
-        # These headers exist only a bounce mail from Office365
-        return nil if mhead['x-ms-exchange-crosstenant-originalarrivaltime']
-        return nil if mhead['x-ms-exchange-crosstenant-fromentityheader']
+        proceedsto  = 0
+        proceedsto += 1 if EmailTitle.any? { |a| mhead["subject"].include?(a) }
+        proceedsto += 1 if MailSender.any? { |a| mhead["from"].include?(a) }
+        proceedsto += 1 if mhead["content-language"]
+        return nil if proceedsto < 2
 
+        require "sisimai/rfc1123"
+        require "sisimai/smtp/reply"
+        require "sisimai/smtp/status"
         dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
         emailparts = Sisimai::RFC5322.part(mbody, Boundaries)
         bodyslices = emailparts[0].split("\n")
         readcursor = 0      # (Integer) Points the current cursor position
         recipients = 0      # (Integer) The number of 'Final-Recipient' header
-        connvalues = 0      # (Integer) Flag, 1 if all the value of connheader have been set
-        connheader = {
-          'rhost' => '',    # The value of Reporting-MTA header or "Generating Server:"
-        }
-        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 MarkingsOf[:message].any? { |a| e.start_with?(a) }
+            readcursor |= Indicators[:deliverystatus] if StartingOf[:message].any? { |a| e.start_with?(a) }
             next
           end
           next if (readcursor & Indicators[:deliverystatus]) == 0
+          next if e == ""
 
-          if connvalues == connheader.keys.size
-            # Diagnostic information for administrators:
-            #
-            # Generating server: mta2.neko.example.jp
-            #
-            # kijitora@example.jp
-            # #550 5.1.1 RESOLVER.ADR.RecipNotFound; not found ##
-            #
-            # Original message headers:
-            v = dscontents[-1]
+          # Diagnostic information for administrators:
+          #
+          # Generating server: mta2.neko.example.jp
+          #
+          # kijitora@example.jp
+          # #550 5.1.1 RESOLVER.ADR.RecipNotFound; not found ##
+          #
+          # Original message headers:
+          v = dscontents[-1]
 
-            if e.include?('@') && e.include?(' ') == false
-              # 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'] = Sisimai::Address.s3s4(e)
-              v['diagnosis'] = ''
-              recipients += 1
+          if e.include?('@') && e.include?(' ') == false
+            # 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"] = Sisimai::Address.s3s4(e)
+            v["diagnosis"] = ""
+            recipients += 1
 
+          else
+            # Try to pick the remote hostname and status code, reply code from the error message
+            if StartingOf[:rhost].any? { |a| e.start_with?(a) }
+              # Generating server: SG2APC01HT234.mail.protection.outlook.com
+              # DSN generated by:       NEKONYAAN0022.apcprd01.prod.exchangelabs.com
+              cv = Sisimai::RFC1123.find(e)
+              v["rhost"] = cv if Sisimai::RFC1123.is_internethost(cv)
             else
-              # Continued line of error messages
-              cr = Sisimai::SMTP::Reply.find(e)
-              cs = Sisimai::SMTP::Status.find(e)
-              if cr || cs
-                # #550 5.1.1 RESOLVER.ADR.RecipNotFound; not found ##
-                # #550 5.2.3 RESOLVER.RST.RecipSizeLimit; message too large for this recipient ##
+              # #550 5.1.1 RESOLVER.ADR.RecipNotFound; not found ##
+              # #550 5.2.3 RESOLVER.RST.RecipSizeLimit; message too large for this recipient ##
+              cr = Sisimai::SMTP::Reply.find(e)  || ""
+              cs = Sisimai::SMTP::Status.find(e) || ""
+              if cr != "" || cs != "" || e.include?("Remote Server ")
                 # Remote Server returned '550 5.1.1 RESOLVER.ADR.RecipNotFound; not found'
                 # 3/09/2016 8:05:56 PM - Remote Server at mydomain.com (10.1.1.3) returned '550 4.4.7 QUEUE.Expired; message expired'
-                v['replycode'] = cr || ''
-                v['status']    = cs || ''
-                v['diagnosis'] = e
-              else
-                # Continued line of error messages
-                next if v['diagnosis'].to_s.empty?
-                next unless v['diagnosis'].end_with?('=')
-                v['diagnosis']  = v['diagnosis'].chomp('=')
-                v['diagnosis'] << e
+                v["replycode"] = cr
+                v["status"]    = cs
+                v["diagnosis"] << e << " "
               end
             end
-          else
-            # Diagnostic information for administrators:
-            #
-            # Generating server: mta22.neko.example.org
-            next unless MarkingsOf[:rhost].any? { |a| e.start_with?(a) }
-            next unless connheader['rhost'].empty?
-            connheader['rhost'] = e[e.index(':') + 1, e.size]
-            connvalues += 1
           end
         end
+
+        while recipients == 0
+          # Try to pick the recipient address from the following formatted bounce message:
+          #   Original Message Details
+          #   Created Date:   4/29/2017 11:23:34 PM
+          #   Sender Address: neko@example.com
+          #   Recipient Address:      kijitora-nyaan@neko.kyoto.example.jp
+          #   Subject:        Nyaan?
+          p1 = emailparts[0].index("Original Message Details"); break if p1.nil?
+          p2 = emailparts[0].index("\nRecipient Address: ");    break if p2.nil?
+          p3 = emailparts[0].index("\n", p2 + 20);              break if p3.nil?
+          cv = Sisimai::Address.s3s4(emailparts[0][p2 + 20, p3 - p2 - 20])
+
+          break unless Sisimai::Address.is_emailaddress(cv)
+          dscontents[0]["recipient"] = cv
+          recipients += 1
+        end
         return nil unless recipients > 0
 
         dscontents.each do |e|
-          p = -1
-          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
-          MarkingsOf[:error].each do |q|
-            # Find an error message, get an error code.
-            p = e['diagnosis'].index(q) || -1
-            break if p > -1
+          # Tidy up the error message in $e->{'diagnosis'}, Try to detect the bounce reason.
+          e["diagnosis"] = Sisimai::String.sweep(e["diagnosis"])
+
+          p0 = -1; StartingOf[:error].each do |r|
+            # Try to find the NDR subject string such as "RESOLVER.ADR.RecipientNotFound" from the
+            # error message
+            p0 = e["diagnosis"].index(r); break if p0.nil? == false
           end
-          next unless p > 0
+          next if p0.nil?
 
           # #550 5.1.1 RESOLVER.ADR.RecipNotFound; not found ##
-          f = e['diagnosis'][p + 1, e['diagnosis'].index(';') - p - 1]
-          NDRSubject.each_key do |r|
-            # Try to match with error subject strings
-            next unless f == r
-            e['reason'] = NDRSubject[r]
-            break
-          end
+          cv = e["diagnosis"][p0 + 1, e["diagnosis"].index(";") - p0 - 1]
+          next if NDRSubject.has_key?(cv) == false
+          e["reason"] = NDRSubject[cv]
         end
 
-        return { 'ds' => dscontents, 'rfc822' => emailparts[1] }
+        return { "ds" => dscontents, "rfc822" => emailparts[1] }
       end
       def description; return 'Microsoft Exchange Server 2007'; end
     end