sisimai 4.21.1-java → 4.22.0-java

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

@@ -0,0 +1,207 @@
+module Sisimai::Bite::Email
+  module Outlook
+    # Sisimai::Bite::Email::Outlook parses a bounce email which created by
+    # Microsoft Outlook.com.
+    # Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/US/Outlook.pm
+      require 'sisimai/bite/email'
+
+      Re0 = {
+        :from     => %r/postmaster[@]/,
+        :subject  => %r/Delivery Status Notification/,
+        :received => %r/.+[.]hotmail[.]com\b/,
+      }
+      Re1 = {
+        :begin  => %r/\AThis is an automatically generated Delivery Status Notification/,
+        :error  => %r/\A[.]+ while talking to .+[:]\z/,
+        :rfc822 => %r|\AContent-Type: message/rfc822\z|,
+        :endof  => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      ReFailure = {
+        hostunknown: %r/The mail could not be delivered to the recipient because the domain is not reachable/,
+        userunknown: %r/Requested action not taken: mailbox unavailable/,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'Microsoft Outlook.com: https://www.outlook.com/'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+
+      # X-Message-Delivery: Vj0xLjE7RD0wO0dEPTA7U0NMPTk7bD0xO3VzPTE=
+      # X-Message-Info: AuEzbeVr9u5fkDpn2vR5iCu5wb6HBeY4iruBjnutBzpStnUabbM...
+      def headerlist;  return ['X-Message-Delivery', 'X-Message-Info']; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from Microsoft Outlook.com
+      # @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['x-message-delivery']
+        match += 1 if mhead['x-message-info']
+        match += 1 if mhead['received'].find { |a| a =~ Re0[:received] }
+        return nil if match < 2
+
+        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
+              # This is an automatically generated Delivery Status Notification.
+              #
+              # Delivery to the following recipients failed.
+              #
+              #      kijitora@example.jp
+              #
+              # Final-Recipient: rfc822;kijitora@example.jp
+              # Action: failed
+              # Status: 5.2.2
+              # Diagnostic-Code: smtp;550 5.2.2 <kijitora@example.jp>... Mailbox Full
+              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.2.0
+                v['status'] = cv[1]
+
+              else
+                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
+              # Reporting-MTA: dns;BLU004-OMC3S13.hotmail.example.com
+              # Received-From-MTA: dns;BLU436-SMTP66
+              # Arrival-Date: Fri, 21 Nov 2014 14:17:34 -0800
+              if cv = e.match(/\A[Rr]eporting-MTA:[ ]*(?:DNS|dns);[ ]*(.+)\z/)
+                # Reporting-MTA: dns;BLU004-OMC3S13.hotmail.example.com
+                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'
+
+        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'] = Sisimai::String.sweep(e['diagnosis']) || ''
+
+          if e['diagnosis'].empty?
+            # No message in 'diagnosis'
+            if e['action'] == 'delayed'
+              # Set pseudo diagnostic code message for delaying
+              e['diagnosis'] = 'Delivery to the following recipients has been delayed.'
+
+            else
+              # Set pseudo diagnostic code message
+              e['diagnosis']  = 'Unable to deliver message to the following recipients, '
+              e['diagnosis'] += 'due to being unable to connect successfully to the destination mail server.'
+            end
+          end
+
+          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/postfix.rb

@@ -0,0 +1,310 @@
+module Sisimai::Bite::Email
+  module Postfix
+    # Sisimai::Bite::Email::Postfix parses a bounce email which created by
+    # Postfix. Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/Postfix.pm
+      require 'sisimai/bite/email'
+
+      # Postfix manual - bounce(5) - http://www.postfix.org/bounce.5.html
+      Re0 = {
+        :from    => %r/ [(]Mail Delivery System[)]\z/,
+        :subject => %r/\AUndelivered Mail Returned to Sender\z/,
+      }
+      Re1 = {
+        :begin => %r{\A(?>
+           [ ]+The[ ](?:
+             Postfix[ ](?:
+               program\z              # The Postfix program
+              |on[ ].+[ ]program\z    # The Postfix on <os name> program
+              )
+            |\w+[ ]Postfix[ ]program\z  # The <name> Postfix program
+            |mail[ \t]system\z             # The mail system
+            |\w+[ \t]program\z             # The <custmized-name> program
+            )
+          |This[ ]is[ ]the[ ](?:
+             Postfix[ ]program          # This is the Postfix program
+            |\w+[ ]Postfix[ ]program    # This is the <name> Postfix program
+            |\w+[ ]program              # This is the <customized-name> Postfix program
+            |mail[ ]system[ ]at[ ]host  # This is the mail system at host <hostname>.
+            )
+          )
+        }x,
+        :rfc822 => %r!\AContent-Type:[ \t]*(?:message/rfc822|text/rfc822-headers)\z!x,
+        :endof  => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'Postfix'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def headerlist;  return []; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from Postfix
+      # @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]
+
+        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
+        commandset = []     # (Array) ``in reply to * command'' list
+        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 Received-From-MTA header
+        }
+        anotherset = {}     # Another error information
+        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; userunknown@example.jp
+              # X-Actual-Recipient: RFC822; kijitora@example.co.jp
+              # Action: failed
+              # Status: 5.1.1
+              # Remote-MTA: DNS; mx.example.jp
+              # Diagnostic-Code: SMTP; 550 5.1.1 <userunknown@example.jp>... User Unknown
+              # Last-Attempt-Date: Fri, 14 Feb 2014 12:30:08 -0500
+              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[Xx]-[Aa]ctual-[Rr]ecipient:[ ]*(?:RFC|rfc)822;[ ]*([^ ]+)\z/) ||
+                         e.match(/\A[Oo]riginal-[Rr]ecipient:[ ]*(?:RFC|rfc)822;[ ]*([^ ]+)\z/)
+                # X-Actual-Recipient: RFC822; kijitora@example.co.jp
+                # Original-Recipient: rfc822;kijitora@example.co.jp
+                v['alias'] = cv[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
+                # Status:5.2.0
+                # Status: 5.1.0 (permanent failure)
+                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
+
+              elsif cv = e.match(/\A[Ll]ast-[Aa]ttempt-[Dd]ate:[ ]*(.+)\z/)
+                # Last-Attempt-Date: Fri, 14 Feb 2014 12:30:08 -0500
+                #
+                # src/bounce/bounce_notify_util.c:
+                #   681  #if 0
+                #   682      if (dsn->time > 0)
+                #   683          post_mail_fprintf(bounce, "Last-Attempt-Date: %s",
+                #   684                            mail_date(dsn->time));
+                #   685  #endif
+                v['date'] = cv[1]
+
+              else
+                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]
+                  v['spec'] = 'SMTP' if v['spec'] == 'X-POSTFIX'
+
+                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
+              # If you do so, please include this problem report. You can
+              # delete your own text from the attached returned message.
+              #
+              #           The mail system
+              #
+              # <userunknown@example.co.jp>: host mx.example.co.jp[192.0.2.153] said: 550
+              # 5.1.1 <userunknown@example.co.jp>... User Unknown (in reply to RCPT TO
+              # command)
+              if cv = e.match(/[ \t][(]in reply to ([A-Z]{4}).*/)
+                # 5.1.1 <userunknown@example.co.jp>... User Unknown (in reply to RCPT TO
+                commandset << cv[1]
+                anotherset['diagnosis'] ||= ''
+                anotherset['diagnosis'] += ' ' + e
+
+              elsif cv = e.match(/([A-Z]{4})[ \t]*.*command[)]\z/)
+                # to MAIL command)
+                commandset << cv[1]
+                anotherset['diagnosis'] ||= ''
+                anotherset['diagnosis'] += ' ' + e
+
+              else
+                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'] = 1
+                  connvalues += 1
+
+                elsif cv = e.match(/\A(X-Postfix-Sender):[ ]*rfc822;[ ]*(.+)\z/)
+                  # X-Postfix-Sender: rfc822; shironeko@example.org
+                  rfc822list << sprintf('%s: %s', cv[1], cv[2])
+
+                else
+                  # Alternative error message and recipient
+                  if cv = e.match(/\A[<]([^ ]+[@][^ ]+)[>] [(]expanded from [<](.+)[>][)]:[ \t]*(.+)\z/)
+                    # <r@example.ne.jp> (expanded from <kijitora@example.org>): user ...
+                    anotherset['recipient'] = cv[1]
+                    anotherset['alias']     = cv[2]
+                    anotherset['diagnosis'] = cv[3]
+
+                  elsif cv = e.match(/\A[<]([^ ]+[@][^ ]+)[>]:(.*)\z/)
+                    # <kijitora@exmaple.jp>: ...
+                    anotherset['recipient'] = cv[1]
+                    anotherset['diagnosis'] = cv[2]
+
+                  else
+                    # Get error message continued from the previous line
+                    next unless anotherset['diagnosis']
+                    if e =~ /\A[ \t]{4}(.+)\z/
+                      #    host mx.example.jp said:...
+                      anotherset['diagnosis'] += ' ' + e
+                    end
+                  end
+
+                end
+              end
+            end
+          end # End of if: rfc822
+        end
+
+        if recipients.zero?
+          # Fallback: set recipient address from error message
+          if anotherset['recipient'] && anotherset['recipient'].size > 0
+            # Set recipient address
+            dscontents[-1]['recipient'] = anotherset['recipient']
+            recipients += 1
+          end
+        end
+        return nil if recipients.zero?
+
+        require 'sisimai/string'
+        require 'sisimai/smtp/status'
+        require 'sisimai/smtp/reply'
+
+        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['command'] = commandset.shift || ''
+
+          if anotherset['diagnosis']
+            # Copy alternative error message
+            e['diagnosis'] = anotherset['diagnosis'] unless e['diagnosis']
+
+            if e['diagnosis'] =~ /\A\d+\z/
+              e['diagnosis'] = anotherset['diagnosis']
+            else
+              # More detailed error message is in "$anotherset"
+              as = nil  # status
+              ar = nil  # replycode
+
+              if e['status'] == '' || e['status'] =~ /\A[45][.]0[.]0\z/
+                # Check the value of D.S.N. in $anotherset
+                as = Sisimai::SMTP::Status.find(anotherset['diagnosis'])
+                if as.size > 0 && as[-3, 3] != '0.0'
+                  # The D.S.N. is neither an empty nor *.0.0
+                  e['status'] = as
+                end
+              end
+
+              if e['replycode'] == '' || e['replycode'] =~ /\A[45]00\z/
+                # Check the value of SMTP reply code in $anotherset
+                ar = Sisimai::SMTP::Reply.find(anotherset['diagnosis'])
+                if ar.size > 0 && ar[-2, 2].to_i != 0
+                  # The SMTP reply code is neither an empty nor *00
+                  e['replycode'] = ar
+                end
+              end
+
+              if ( as || ar ) && ( anotherset['diagnosis'].size > e['diagnosis'].size )
+                # Update the error message in $e->{'diagnosis'}
+                e['diagnosis'] = anotherset['diagnosis']
+              end
+            end
+          end
+
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+          e['spec']    ||= 'SMTP' if e['diagnosis'] =~ /host .+ said:/
+          e.each_key { |a| e[a] ||= '' }
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end
+