RubyGems - sisimai - Versions diffs - 4.25.3 → 4.25.8 - Mend

sisimai 4.25.3 → 4.25.8

Potentially problematic release.

This version of sisimai might be problematic. Click here for more details.

Files changed (731) hide show

data/lib/sisimai/lhost/amazonworkmail.rb ADDED

@@ -0,0 +1,131 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::AmazonWorkMail parses a bounce email which created by
+  # Amazon WorkMail. Methods in the module are called from only Sisimai::Message.
+  module AmazonWorkMail
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/AmazonWorkMail.pm
+      require 'sisimai/lhost'
+      # https://aws.amazon.com/workmail/
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r|^content-type:[ ]message/rfc822|.freeze
+      StartingOf = { message: ['Technical report:'] }.freeze
+      # Parse bounce messages from Amazon WorkMail
+      # @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: Amazon WorkMail
+        # X-Original-Mailer: Amazon WorkMail
+        # X-Ses-Outgoing: 2016.01.14-54.240.27.159
+        match = 0
+        xmail = mhead['x-original-mailer'] || mhead['x-mailer'] || ''
+        match += 1 if mhead['x-ses-outgoing']
+        unless xmail.empty?
+          # X-Mailer: Amazon WorkMail
+          # X-Original-Mailer: Amazon WorkMail
+          match += 1 if xmail == 'Amazon WorkMail'
+        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
+        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 == StartingOf[:message][0]
+            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
+            o = Sisimai::RFC1894.field(e) || next
+            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
+          end
+          # <!DOCTYPE HTML><html>
+          # <head>
+          # <meta name="Generator" content="Amazon WorkMail v3.0-2023.77">
+          # <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+          break if e.start_with?('<!DOCTYPE HTML><html>')
+        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'])
+          if e['status'].to_s.start_with?('5.0.0', '5.1.0', '4.0.0', '4.1.0')
+            # Get other D.S.N. value from the error message
+            errormessage = e['diagnosis']
+            if cv = e['diagnosis'].match(/["'](\d[.]\d[.]\d.+)['"]/)
+              # 5.1.0 - Unknown address error 550-'5.7.1 ...
+              errormessage = cv[1]
+            end
+            e['status'] = Sisimai::SMTP::Status.find(errormessage) || e['status']
+          end
+          if cv = e['diagnosis'].match(/[<]([245]\d\d)[ ].+[>]/)
+            # 554 4.4.7 Message expired: unable to deliver in 840 minutes.
+            # <421 4.4.2 Connection timed out>
+            e['replycode'] = cv[1]
+          end
+          e['reason'] ||= Sisimai::SMTP::Status.name(e['status']) || ''
+        end
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'Amazon WorkMail: https://aws.amazon.com/workmail/'; end
+    end
+  end
+end

data/lib/sisimai/lhost/aol.rb ADDED

@@ -0,0 +1,128 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::Aol parses a bounce email which created by Aol Mail.
+  # Methods in the module are called from only Sisimai::Message.
+  module Aol
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/Aol.pm
+      require 'sisimai/lhost'
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r|^Content-Type:[ ]message/rfc822|.freeze
+      StartingOf = { message: ['Content-Type: message/delivery-status'] }.freeze
+      MessagesOf = {
+        'hostunknown' => ['Host or domain name not found'],
+        'notaccept'   => ['type=MX: Malformed or unexpected name server reply'],
+      }.freeze
+      # Parse bounce messages from Aol Mail
+      # @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-AOL-IP: 192.0.2.135
+        # X-AOL-VSS-INFO: 5600.1067/98281
+        # X-AOL-VSS-CODE: clean
+        # x-aol-sid: 3039ac1afc14546fb98a0945
+        # X-AOL-SCOLL-EIL: 1
+        # x-aol-global-disposition: G
+        # x-aol-sid: 3039ac1afd4d546fb97d75c6
+        # X-BounceIO-Id: 9D38DE46-21BC-4309-83E1-5F0D788EFF1F.1_0
+        # X-Outbound-Mail-Relay-Queue-ID: 07391702BF4DC
+        # X-Outbound-Mail-Relay-Sender: rfc822; shironeko@aol.example.jp
+        return nil unless mhead['x-aol-ip']
+        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
+        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.start_with?(StartingOf[:message][0])
+            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
+            # 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
+        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'].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
+          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
+        end
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'Aol Mail: https://www.aol.com'; end
+    end
+  end
+end

data/lib/sisimai/lhost/apachejames.rb ADDED

@@ -0,0 +1,120 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::ApacheJames parses a bounce email which created by ApacheJames.
+  # Methods in the module are called from only Sisimai::Message.
+  module ApacheJames
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/ApacheJames.pm
+      require 'sisimai/lhost'
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r|^Content-Type:[ ]message/rfc822|.freeze
+      StartingOf = {
+        # apache-james-2.3.2/src/java/org/apache/james/transport/mailets/
+        #   AbstractNotify.java|124:  out.println("Error message below:");
+        #   AbstractNotify.java|128:  out.println("Message details:");
+        message: [''],
+        error:   ['Error message below:'],
+      }.freeze
+      # Parse bounce messages from Apache James
+      # @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['subject'] == '[BOUNCE]'
+        match += 1 if mhead['message-id'].to_s.include?('.JavaMail.')
+        match += 1 if mhead['received'].any? { |a| a.include?('JAMES SMTP Server') }
+        return nil unless match > 0
+        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
+        diagnostic = ''     # (String) Alternative diagnostic message
+        subjecttxt = nil    # (String) Alternative Subject text
+        gotmessage = nil    # (Boolean) Flag for error message
+        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?
+          # Message details:
+          #   Subject: Nyaaan
+          #   Sent date: Thu Apr 29 01:20:50 JST 2015
+          #   MAIL FROM: shironeko@example.jp
+          #   RCPT TO: kijitora@example.org
+          #   From: Neko <shironeko@example.jp>
+          #   To: kijitora@example.org
+          #   Size (in bytes): 1024
+          #   Number of lines: 64
+          v = dscontents[-1]
+          if cv = e.match(/\A[ ][ ]RCPT[ ]TO:[ ]([^ ]+[@][^ ]+)\z/)
+            #   RCPT TO: kijitora@example.org
+            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(/\A[ ][ ]Sent[ ]date:[ ](.+)\z/)
+            #   Sent date: Thu Apr 29 01:20:50 JST 2015
+            v['date'] = cv[1]
+          elsif cv = e.match(/\A[ ][ ]Subject:[ ](.+)\z/)
+            #   Subject: Nyaaan
+            subjecttxt = cv[1]
+          else
+            next if gotmessage
+            if v['diagnosis']
+              # Get an error message text
+              if e.start_with?('Message details:')
+                # Message details:
+                #   Subject: nyaan
+                #   ...
+                gotmessage = true
+              else
+                # Append error message text like the followng:
+                #   Error message below:
+                #   550 - Requested action not taken: no such user here
+                v['diagnosis'] << ' ' << e
+              end
+            else
+              # Error message below:
+              # 550 - Requested action not taken: no such user here
+              v['diagnosis'] = e if e == StartingOf[:error][0]
+              unless gotmessage
+                v['diagnosis'] ||= ''
+                v['diagnosis'] << ' ' + e
+              end
+            end
+          end
+        end
+        return nil unless recipients > 0
+        # 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: /
+        dscontents.each { |e| e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'] || diagnostic) }
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'Java Apache Mail Enterprise Server'; end
+    end
+  end
+end

data/lib/sisimai/lhost/barracuda.rb ADDED

@@ -0,0 +1,94 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::Barracuda parses a bounce email which created by Barracuda.
+  # Methods in the module are called from only Sisimai::Message.
+  module Barracuda
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/Barracuda.pm
+      require 'sisimai/lhost'
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r|^Content-Type:[ ]text/rfc822-headers|.freeze
+      StartingOf = { message: ['Your message to:'] }.freeze
+      # Parse bounce messages from Barracuda
+      # @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)
+        # Subject: **Message you sent blocked by our bulk email filter**
+        return nil unless mhead['subject'].to_s.end_with?('our bulk email filter**')
+        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
+        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.start_with?(StartingOf[:message][0])
+            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
+          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['diagnosis'] = Sisimai::String.sweep(e['diagnosis'].to_s.tr("\n", ' '))
+        end
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'Barracuda: https://www.barracuda.com'; end
+    end
+  end
+end