sisimai 4.21.1-java → 4.22.0-java

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

@@ -0,0 +1,223 @@
+module Sisimai::Bite::Email
+  module SendGrid
+    # Sisimai::Bite::Email::SendGrid parses a bounce email which created by
+    # SendGrid. Methods in the module are called from only Sisimai::Message.
+    class << self
+    # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/SendGrid.pm
+      require 'sisimai/bite/email'
+
+      Re0 = {
+        :'from'        => %r/\AMAILER-DAEMON\z/,
+        :'return-path' => %r/\A[<]apps[@]sendgrid[.]net[>]\z/,
+        :'subject'     => %r/\AUndelivered Mail Returned to Sender\z/,
+      }
+      Re1 = {
+        :begin  => %r/\AThis is an automatically generated message from SendGrid[.]\z/,
+        :error  => %r/\AIf you require assistance with this, please contact SendGrid support[.]\z/,
+        :rfc822 => %r|\AContent-Type: message/rfc822|,
+        :endof  => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'SendGrid: http://sendgrid.com/'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+
+      # Return-Path: <apps@sendgrid.net>
+      # X-Mailer: MIME-tools 5.502 (Entity 5.502)
+      def headerlist;  return ['Return-Path', 'X-Mailer']; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from SendGrid
+      # @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['return-path']
+        return nil unless mhead['return-path'] =~ Re0[:'return-path']
+        return nil unless mhead['subject']     =~ Re0[:'subject']
+
+        require 'sisimai/datetime'
+        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
+        commandtxt = ''     # (String) SMTP Command name begin with the string '>>>'
+        connvalues = 0      # (Integer) Flag, 1 if all the value of $connheader have been set
+        connheader = {
+          'date' => '',     # The value of Arrival-Date 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.jp
+              # Original-Recipient: rfc822; kijitora@example.jp
+              # Action: failed
+              # Status: 5.1.1
+              # Diagnostic-Code: 550 5.1.1 <kijitora@example.jp>... User Unknown
+              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.1.1
+                # Status:5.2.0
+                # Status: 5.1.0 (permanent failure)
+                v['status'] = cv[1]
+
+              else
+                if cv = e.match(/\A[Dd]iagnostic-[Cc]ode:[ ]*(.+)\z/)
+                  # Diagnostic-Code: 550 5.1.1 <userunknown@example.jp>... User Unknown
+                  v['diagnosis'] = cv[1]
+
+                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
+              # This is an automatically generated message from SendGrid.
+              #
+              # I'm sorry to have to tell you that your message was not able to be
+              # delivered to one of its intended recipients.
+              #
+              # If you require assistance with this, please contact SendGrid support.
+              #
+              # shironekochan:000000:<kijitora@example.jp> : 192.0.2.250 : mx.example.jp:[192.0.2.153] :
+              #   550 5.1.1 <userunknown@cubicroot.jp>... User Unknown  in RCPT TO
+              #
+              # ------------=_1351676802-30315-116783
+              # Content-Type: message/delivery-status
+              # Content-Disposition: inline
+              # Content-Transfer-Encoding: 7bit
+              # Content-Description: Delivery Report
+              #
+              # X-SendGrid-QueueID: 959479146
+              # X-SendGrid-Sender: <bounces+61689-10be-kijitora=example.jp@sendgrid.info>
+              # Arrival-Date: 2012-12-31 23-59-59
+              if cv = e.match(/.+ in (?:End of )?([A-Z]{4}).*\z/)
+                # in RCPT TO, in MAIL FROM, end of DATA
+                commandtxt = cv[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
+                arrivaldate = cv[1]
+
+                if cv = e.match(/\A[Aa]rrival-[Dd]ate: (\d{4})[-](\d{2})[-](\d{2}) (\d{2})[-](\d{2})[-](\d{2})\z/)
+                  # Arrival-Date: 2011-08-12 01-05-05
+                  arrivaldate += 'Thu, ' + cv[3] + ' '
+                  arrivaldate += Sisimai::DateTime.monthname(0)[cv[2].to_i - 1]
+                  arrivaldate += ' ' + cv[1] + ' ' + [cv[4], cv[5], cv[6]].join(':')
+                  arrivaldate += ' ' + Sisimai::DateTime.abbr2tz('CDT')
+                end
+                connheader['date'] = arrivaldate
+                connvalues += 1
+              end
+            end
+          end
+        end
+
+        return nil if recipients.zero?
+        require 'sisimai/string'
+        require 'sisimai/smtp/status'
+
+        dscontents.map do |e|
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+
+          # Get the value of SMTP status code as a pseudo D.S.N.
+          if cv = e['diagnosis'].match(/\b([45])\d\d[ \t]*/)
+            # 4xx or 5xx
+            e['status'] = sprintf("%d.0.0", cv[1])
+          end
+
+          if e['status'] =~ /[45][.]0[.]0/
+            # Get the value of D.S.N. from the error message or the value of
+            # Diagnostic-Code header.
+            pseudostatus = Sisimai::SMTP::Status.find(e['diagnosis'])
+            e['status'] = pseudostatus if pseudostatus.size > 0
+          end
+
+          if e['action'] == 'expired'
+            # Action: expired
+            e['reason'] = 'expired'
+            if !e['status'] || e['status'] =~ /[45][.]0[.]0/
+              # Set pseudo Status code value if the value of Status is not
+              # defined or 4.0.0 or 5.0.0.
+              pseudostatus = Sisimai::SMTP::Status.code('expired')
+              e['status']  = pseudostatus if pseudostatus.size > 0
+            end
+          end
+
+          e['agent']   = self.smtpagent
+          e['command'] = commandtxt
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end
+

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

@@ -0,0 +1,290 @@
+module Sisimai::Bite::Email
+  module Sendmail
+    # Sisimai::Bite::Email::Sendmail parses a bounce email which created by
+    # v8 Sendmail. Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/Sendmail.pm
+      require 'sisimai/bite/email'
+
+      Re0 = {
+        :from    => %r/\AMail Delivery Subsystem/,
+        :subject => %r/(?:see transcript for details\z|\AWarning: )/,
+      }
+      # Error text regular expressions which defined in sendmail/savemail.c
+      #   savemail.c:1040|if (printheader && !putline("   ----- Transcript of session follows -----\n",
+      #   savemail.c:1041|          mci))
+      #   savemail.c:1042|  goto writeerr;
+      #
+      Re1 = {
+        :begin   => %r/\A[ \t]+[-]+ Transcript of session follows [-]+\z/,
+        :error   => %r/\A[.]+ while talking to .+[:]\z/,
+        :rfc822  => %r{\AContent-Type:[ ]*(?:message/rfc822|text/rfc822-headers)\z},
+        :endof   => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'V8Sendmail: /usr/sbin/sendmail'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def headerlist;  return []; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from Sendmail
+      # @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]
+
+        unless mhead['subject'] =~ /\A[ \t]*Fwd?:/i
+          # Fwd: Returned mail: see transcript for details
+          # Do not execute this code if the bounce mail is a forwarded message.
+          return nil unless mhead['from'] =~ Re0[:from]
+        end
+
+        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
+        commandtxt = ''     # (String) SMTP Command name begin with the string '>>>'
+        esmtpreply = ''     # (String) Reply from remote server on SMTP session
+        sessionerr = false  # (Boolean) Flag, "true" if it is SMTP session error
+        connvalues = 0      # (Integer) Flag, 1 if all the value of $connheader have been set
+        connheader = {
+          'date'  => '',    # The value of Arrival-Date header
+          'rhost' => '',    # The value of Reporting-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/)
+                # X-Actual-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
+                v['rhost'] = '' if v['rhost'] =~ /\A\s+\z/  # Remote-MTA: DNS;
+
+              elsif cv = e.match(/\A[Ll]ast-[Aa]ttempt-[Dd]ate:[ ]*(.+)\z/)
+                # Last-Attempt-Date: Fri, 14 Feb 2014 12:30:08 -0500
+                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]
+
+                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
+              # ----- Transcript of session follows -----
+              # ... while talking to mta.example.org.:
+              # >>> DATA
+              # <<< 550 Unknown user recipient@example.jp
+              # 554 5.0.0 Service unavailable
+              # ...
+              # Reporting-MTA: dns; mx.example.jp
+              # Received-From-MTA: DNS; x1x2x3x4.dhcp.example.ne.jp
+              # Arrival-Date: Wed, 29 Apr 2009 16:03:18 +0900
+              if cv = e.match(/\A[>]{3}[ ]+([A-Z]{4})[ ]?/)
+                # >>> DATA
+                commandtxt = cv[1]
+
+              elsif cv = e.match(/\A[<]{3}[ ]+(.+)\z/)
+                # <<< Response
+                esmtpreply = cv[1]
+
+              elsif cv = e.match(/\A[Rr]eporting-MTA:[ ]*(?:DNS|dns);[ ]*(.+)\z/)
+                # Reporting-MTA: dns; mx.example.jp
+                next if connheader['rhost'].size > 0
+                connheader['rhost'] = cv[1].downcase
+                connvalues += 1
+
+              elsif cv = e.match(/\A[Rr]eceived-[Ff]rom-MTA:[ ]*(?:DNS|dns);[ ]*(.+)\z/)
+                # Received-From-MTA: DNS; x1x2x3x4.dhcp.example.ne.jp
+                next if connheader['lhost']
+
+                # The value of "lhost" is optional
+                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
+
+              else
+                # Detect SMTP session error or connection error
+                next if sessionerr
+                if e =~ Re1[:error]
+                  # ----- Transcript of session follows -----
+                  # ... while talking to mta.example.org.:
+                  sessionerr = true
+                  next
+                end
+
+                if cv = e.match(/\A[<](.+)[>][.]+ (.+)\z/)
+                  # <kijitora@example.co.jp>... Deferred: Name server: example.co.jp.: host name lookup failure
+                  anotherset['recipient'] = cv[1]
+                  anotherset['diagnosis'] = cv[2]
+
+                else
+                  # ----- Transcript of session follows -----
+                  # Message could not be delivered for too long
+                  # Message will be deleted from queue
+                  next if e =~ /\A[ \t]*[-]+/
+                  if cv = e.match(/\A[45]\d\d[ \t]([45][.]\d[.]\d)[ \t].+/)
+                    # 550 5.1.2 <kijitora@example.org>... Message
+                    #
+                    # DBI connect('dbname=...')
+                    # 554 5.3.0 unknown mailer error 255
+                    anotherset['status'] = cv[1]
+                    anotherset['diagnosis'] ||= ''
+                    anotherset['diagnosis']  += ' ' + e
+
+                  elsif e =~ /\A(?:Message|Warning:) /
+                    # Message could not be delivered for too long
+                    # Warning: message still undelivered after 4 hours
+                    anotherset['diagnosis'] ||= ''
+                    anotherset['diagnosis'] += ' ' + e
+                  end
+                end
+              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['command'] ||= commandtxt
+          if e['command'].empty?
+            e['command'] = 'EHLO' if esmtpreply.size > 0
+          end
+
+          if anotherset['diagnosis']
+            # Copy alternative error message
+            e['diagnosis'] = anotherset['diagnosis'] if e['diagnosis'] =~ /\A[ \t]+\z/
+            e['diagnosis'] = anotherset['diagnosis'] unless e['diagnosis']
+
+            if e['diagnosis'] =~ /\A\d+\z/
+              # Override the value of diagnostic code message
+              e['diagnosis'] = anotherset['diagnosis']
+            end
+          end
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+
+          if anotherset['status']
+            # Check alternative status code
+            if e['status'].empty? || e['status'] !~ /\A[45][.]\d[.]\d\z/
+              # Override alternative status code
+              e['status'] = anotherset['status']
+            end
+          end
+
+          unless e['recipient'] =~ /\A[^ ]+[@][^ ]+\z/
+            # @example.jp, no local part
+            if cv = e['diagnosis'].match(/[<]([^ ]+[@][^ ]+)[>]/)
+              # Get email address from the value of Diagnostic-Code header
+              e['recipient'] = cv[1]
+            end
+          end
+          e.each_key { |a| e[a] ||= '' }
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end