sisimai 4.21.1-java → 4.22.0-java

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

@@ -0,0 +1,192 @@
+module Sisimai::Bite::Email
+  module AmazonWorkMail
+    # Sisimai::Bite::Email::AmazonWorkMail parses a bounce email which created by
+    # Amazon WorkMail. Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/AmazonWorkMail.pm
+      require 'sisimai/bite/email'
+
+      # https://aws.amazon.com/workmail/
+      Re0 = {
+        :'subject'  => %r/Delivery[_ ]Status[_ ]Notification[_ ].+Failure/,
+        :'received' => %r/.+[.]smtp-out[.].+[.]amazonses[.]com\b/,
+        :'x-mailer' => %r/\AAmazon WorkMail\z/,
+      }
+      Re1 = {
+        :begin  => %r/\ATechnical report:\z/,
+        :rfc822 => %r|\Acontent-type: message/rfc822\z|,
+        :endof  => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'Amazon WorkMail: https://aws.amazon.com/workmail/'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+
+      # X-Mailer: Amazon WorkMail
+      # X-Original-Mailer: Amazon WorkMail
+      # X-Ses-Outgoing: 2016.01.14-54.240.27.159
+      def headerlist;  return ['X-SES-Outgoing', 'X-Original-Mailer']; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from Amazon WorkMail
+      # @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
+        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 =~ Re0[:'x-mailer']
+        end
+        return nil if match < 2
+
+        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
+        connvalues = 0      # (Integer) Flag, 1 if all the value of $connheader have been set
+        connheader = {
+          'lhost' => '',    # The value of Reporting-MTA 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?
+
+            if connvalues == connheader.keys.size
+              # Action: failed
+              # Final-Recipient: rfc822; kijitora@libsisimai.org
+              # Diagnostic-Code: smtp; 554 4.4.7 Message expired: unable to deliver in 840 minutes.<421 4.4.2 Connection timed out>
+              # Status: 4.4.7
+              v = dscontents[-1]
+
+              if cv = e.match(/\A[Ff]inal-[Rr]ecipient:[ ]*(?:RFC|rfc)822;[ ]*([^ ]+)\z/)
+                # Final-Recipient: RFC822; kijitora@example.jp
+                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 cv = e.match(/\A[Aa]ction:[ ]*(.+)\z/)
+                # Action: failed
+                v['action'] = cv[1].downcase
+
+              elsif cv = e.match(/\A[Ss]tatus:[ ]*(\d[.]\d+[.]\d+)/)
+                # Status: 5.1.1
+                v['status'] = cv[1]
+
+              else
+                if cv = e.match(/\A[Dd]iagnostic-[Cc]ode:[ ]*(.+?);[ ]*(.+)\z/)
+                  # Diagnostic-Code: SMTP; 550 5.1.1 <kijitora@example.jp>... User Unknown
+                  v['spec'] = cv[1].upcase
+                  v['diagnosis'] = cv[2]
+                end
+              end
+            else
+              # Technical report:
+              #
+              # Reporting-MTA: dsn; a27-85.smtp-out.us-west-2.amazonses.com
+              #
+              if cv = e.match(/\A[Rr]eporting-MTA:[ ]*[DNSdns]+;[ ]*(.+)\z/)
+                # Reporting-MTA: dns; mx.example.jp
+                next if connheader['lhost'].size > 0
+                connheader['lhost'] = cv[1].downcase
+                connvalues += 1
+              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 =~ /\A[<]!DOCTYPE HTML[>][<]html[>]\z/
+          end
+        end
+
+        return nil if recipients.zero?
+        require 'sisimai/string'
+        require 'sisimai/smtp/status'
+
+        dscontents.map do |e|
+          # Set default values if each value is empty.
+          connheader.each_key { |a| e[a] ||= connheader[a] || '' }
+
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+
+          if e['status'] =~ /\A[45][.][01][.]0\z/
+            # 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
+            pseudostatus = Sisimai::SMTP::Status.find(errormessage)
+            e['status'] = pseudostatus if pseudostatus.size > 0
+          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'])
+          e['agent']    = self.smtpagent
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end
+

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

@@ -0,0 +1,208 @@
+module Sisimai::Bite::Email
+  module Aol
+    # Sisimai::Bite::Email::Aol parses a bounce email which created by Aol Mail.
+    # Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/Aol.pm
+      require 'sisimai/bite/email'
+
+      Re0 = {
+        :from    => %r/\APostmaster [<]Postmaster[@]AOL[.]com[>]\z/,
+        :subject => %r/\AUndeliverable: /,
+      }
+      Re1 = {
+        :begin   => %r|\AContent-Type: message/delivery-status|,
+        :rfc822  => %r|\AContent-Type: message/rfc822|,
+        :endof   => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      ReFailure = {
+        hostunknown: %r/Host[ ]or[ ]domain[ ]name[ ]not[ ]found/,
+        notaccept:   %r/type=MX:[ ]Malformed[ ]or[ ]unexpected[ ]name[ ]server[ ]reply/,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'Aol Mail: http://www.aol.com'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+
+      # 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
+      def headerlist;  return ['X-AOL-IP']; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from Aol Mail
+      # @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['x-aol-ip']
+
+        dscontents = [Sisimai::Bite.DELIVERYSTATUS]
+        hasdivided = mbody.split("\n")
+        havepassed = ['']
+        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
+        connvalues = 0      # (Integer) Flag, 1 if all the value of $connheader have been set
+        connheader = {
+          'date'  => '',    # The value of Arrival-Date header
+          'lhost' => '',    # The value of Reporting-MTA header
+        }
+        v = nil
+
+        hasdivided.each do |e|
+          # Save the current line for the next loop
+          havepassed << e
+          p = havepassed[-2]
+
+          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?
+
+            if connvalues == connheader.keys.size
+              # Final-Recipient: rfc822; kijitora@example.co.jp
+              # Original-Recipient: rfc822;kijitora@example.co.jp
+              # Action: failed
+              # Status: 5.2.2
+              # Remote-MTA: dns; mx.example.co.jp
+              # Diagnostic-Code: smtp; 550 5.2.2 <kijitora@example.co.jp>... Mailbox Full
+              v = dscontents[-1]
+
+              if cv = e.match(/\A[Ff]inal-[Rr]ecipient:[ ]*(?:RFC|rfc)822;[ ]*([^ ]+)\z/)
+                # Final-Recipient: RFC822; userunknown@example.jp
+                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 cv = e.match(/\A[Aa]ction:[ ]*(.+)\z/)
+                # Action: failed
+                v['action'] = cv[1].downcase
+
+              elsif cv = e.match(/\A[Ss]tatus:[ ]*(\d[.]\d+[.]\d+)/)
+                # Status:5.2.0
+                v['status'] = cv[1]
+
+              elsif cv = e.match(/\A[Rr]emote-MTA:[ ]*(?:DNS|dns);[ ]*(.+)\z/)
+                # Remote-MTA: DNS; mx.example.jp
+                v['rhost'] = cv[1].downcase
+
+              else
+                # Get error message
+                if cv = e.match(/\A[Dd]iagnostic-[Cc]ode:[ ]*(.+?);[ ]*(.+)\z/)
+                  # Diagnostic-Code: SMTP; 550 5.1.1 <userunknown@example.jp>... User Unknown
+                  v['spec'] = cv[1].upcase
+                  v['diagnosis'] = cv[2]
+
+                elsif p =~ /\A[Dd]iagnostic-[Cc]ode:[ ]*/ && cv = e.match(/\A[ \t]+(.+)\z/)
+                  # Continued line of the value of Diagnostic-Code header
+                  v['diagnosis'] ||= ''
+                  v['diagnosis']  += ' ' + cv[1]
+                  havepassed[-1] = 'Diagnostic-Code: ' + e
+                end
+              end
+
+            else
+              # Content-Type: message/delivery-status
+              # Content-Transfer-Encoding: 7bit
+              #
+              # Reporting-MTA: dns; omr-m5.mx.aol.com
+              # X-Outbound-Mail-Relay-Queue-ID: CCBA43800007F
+              # X-Outbound-Mail-Relay-Sender: rfc822; shironeko@aol.example.jp
+              # Arrival-Date: Fri, 21 Nov 2014 17:14:34 -0500 (EST)
+              if cv = e.match(/\A[Rr]eporting-MTA:[ ]*(?:DNS|dns);[ ]*(.+)\z/)
+                # Reporting-MTA: dns; mx.example.jp
+                next if connheader['lhost'].size > 0
+                connheader['lhost'] = cv[1].downcase
+                connvalues += 1
+
+              elsif cv = e.match(/\A[Aa]rrival-[Dd]ate:[ ]*(.+)\z/)
+                # Arrival-Date: Wed, 29 Apr 2009 16:03:18 +0900
+                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|
+          # Set default values if each value is empty.
+          connheader.each_key { |a| e[a] ||= connheader[a] || '' }
+
+          e['agent']     = self.smtpagent
+          e['diagnosis'] = e['diagnosis'].gsub(/\\n/, ' ')
+          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
+
+          if e['status'].empty? || e['status'] =~ /\A\d[.]0[.]0\z/
+            # There is no value of Status header or the value is 5.0.0, 4.0.0
+            pseudostatus = Sisimai::SMTP::Status.find(e['diagnosis'])
+            e['status'] = pseudostatus if pseudostatus.size > 0
+          end
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,169 @@
+module Sisimai::Bite::Email
+  module ApacheJames
+    # Sisimai::Bite::::Email::ApacheJames parses a bounce email which created by
+    # ApacheJames. Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/ApacheJames.pm
+      require 'sisimai/bite/email'
+
+      Re0 = {
+        :'subject'    => %r/\A\[BOUNCE\]\z/,
+        :'received'   => %r/JAMES SMTP Server/,
+        :'message-id' => %r/\d+[.]JavaMail[.].+[@]/,
+      }
+      Re1 = {
+        # 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:");
+        :begin  => %r/\AContent-Disposition:[ ]inline/,
+        :error  => %r/\AError message below:\z/,
+        :rfc822 => %r|\AContent-Type: message/rfc822|,
+        :endof  => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'Java Apache Mail Enterprise Server'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def headerlist;  return []; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from Apache James
+      # @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['subject'] =~ Re0[:subject]
+        match += 1 if mhead['message-id'] && mhead['message-id'] =~ Re0[:'message-id']
+        match += 1 if mhead['received'].find { |a| a =~ Re0[:received] }
+        return 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
+        diagnostic = ''     # (String) Alternative diagnostic message
+        subjecttxt = nil    # (String) Alternative Subject text
+        gotmessage = -1     # (Integer) Flag for error message
+        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?
+
+            # 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::Bite.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 == 1
+              if v['diagnosis']
+                # Get an error message text
+                if e =~ /\AMessage[ ]details:\z/
+                  # Message details:
+                  #   Subject: nyaan
+                  #   ...
+                  gotmessage = 1
+                else
+                  # Append error message text like the followng:
+                  #   Error message below:
+                  #   550 - Requested action not taken: no such user here
+                  v['diagnosis'] ||= ''
+                  v['diagnosis']  += ' ' + e
+                end
+
+              else
+                # Error message below:
+                # 550 - Requested action not taken: no such user here
+                v['diagnosis'] = e if e =~ Re1[:error]
+              end
+            end
+          end
+        end
+        return nil if recipients.zero?
+        require 'sisimai/string'
+
+        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
+
+        dscontents.map do |e|
+          e['agent']     = self.smtpagent
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'] || diagnostic)
+          e.each_key { |a| e[a] ||= '' }
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end
+