sisimai 4.14.2

data/lib/sisimai/msp/jp/biglobe.rb

@@ -0,0 +1,179 @@
+module Sisimai
+  module MSP::JP
+    # Sisimai::MSP::JP::Biglobe parses a bounce email which created by BIGLOBE.
+    # Methods in the module are called from only Sisimai::Message.
+    module Biglobe
+      # Imported from p5-Sisimail/lib/Sisimai/MSP/JP/Biglobe.pm
+      class << self
+        require 'sisimai/msp'
+        require 'sisimai/rfc5322'
+
+        Re0 = {
+          :subject => %r/\AReturned mail:/,
+          :from    => %r/postmaster[@](?:biglobe|inacatv|tmtv|ttv)[.]ne[.]jp/,
+        }
+        Re1 = {
+          :begin  => %r/\A   ----- The following addresses had delivery problems -----\z/,
+          :error  => %r/\A   ----- Non-delivered information -----\z/,
+          :rfc822 => %r|\AContent-Type: message/rfc822\z|,
+          :endof  => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+        }
+        ReFailure = {
+          'filtered'    => %r/Mail Delivery Failed[.]+ User unknown/,
+          'mailboxfull' => %r/The number of messages in recipient's mailbox exceeded the local limit[.]/,
+        }
+
+        Indicators = Sisimai::MSP.INDICATORS
+        LongFields = Sisimai::RFC5322.LONGFIELDS
+        RFC822Head = Sisimai::RFC5322.HEADERFIELDS
+
+        def description; return 'BIGLOBE: http://www.biglobe.ne.jp'; end
+        def smtpagent;   return 'JP::Biglobe'; end
+        def headerlist;  return ['']; end
+        def pattern;     return Re0; end
+
+        # Parse bounce messages from Biglobe
+        # @param         [Hash] mhead       Message header 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['from']    =~ Re0[:from]
+          return nil unless mhead['subject'] =~ Re0[:subject]
+
+          require 'sisimai/address'
+          dscontents = []; dscontents << Sisimai::MSP.DELIVERYSTATUS
+          hasdivided = mbody.split("\n")
+          rfc822next = { 'from' => false, 'to' => false, 'subject' => false }
+          rfc822part = ''     # (String) message/rfc822-headers part
+          previousfn = ''     # (String) Previous field name
+          readcursor = 0      # (Integer) Points the current cursor position
+          recipients = 0      # (Integer) The number of 'Final-Recipient' header
+          v = nil
+
+          hasdivided.each do |e|
+            if readcursor == 0
+              # 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 cv = e.match(/\A([-0-9A-Za-z]+?)[:][ ]*.+\z/)
+                # Get required headers only
+                lhs = cv[1].downcase
+                previousfn = ''
+                next unless RFC822Head.key?(lhs)
+
+                previousfn  = lhs
+                rfc822part += e + "\n"
+
+              elsif e =~ /\A[ \t]+/
+                # Continued line from the previous line
+                next if rfc822next[previousfn]
+                rfc822part += e + "\n" if LongFields.key?(previousfn)
+
+              else
+                # Check the end of headers in rfc822 part
+                next unless LongFields.key?(previousfn)
+                next unless e.empty?
+                rfc822next[previousfn] = true
+              end
+
+            else
+              # Before "message/rfc822"
+              next if readcursor & Indicators[:'deliverystatus'] == 0
+              next if e.empty?
+
+              # This is a MIME-encapsulated message.
+              #
+              # ----_Biglobe000000/00000.biglobe.ne.jp
+              # Content-Type: text/plain; charset="iso-2022-jp"
+              #
+              #    ----- The following addresses had delivery problems -----
+              # ********@***.biglobe.ne.jp
+              #
+              #    ----- Non-delivered information -----
+              # The number of messages in recipient's mailbox exceeded the local limit.
+              #
+              # ----_Biglobe000000/00000.biglobe.ne.jp
+              # Content-Type: message/rfc822
+              #
+              v = dscontents[-1]
+
+              if cv = e.match(/\A([^ ]+[@][^ ]+)\z/)
+                #    ----- The following addresses had delivery problems -----
+                # ********@***.biglobe.ne.jp
+                if v['recipient']
+                  # There are multiple recipient addresses in the message body.
+                  push dscontents << Sisimai::MSP.DELIVERYSTATUS
+                  v = dscontents[-1]
+                end
+
+                r = Sisimai::Address.s3s4(cv[1])
+                if Sisimai::RFC5322.is_emailaddress(r)
+                  v['recipient'] = r
+                  recipients += 1
+                end
+
+              else
+                next if e =~ /\A[^\w]/
+                v['diagnosis'] ||= ''
+                v['diagnosis'] += e + ' '
+              end
+            end
+          end
+
+          return nil if recipients == 0
+          require 'sisimai/string'
+          require 'sisimai/smtp/status'
+
+          dscontents.map do |e|
+            if mhead['received'].size > 0
+              # Get localhost and remote host name from Received header.
+              r0 = mhead['received']
+              ['lhost', 'rhost'].each { |a| e[a] ||= '' }
+              e['lhost'] = Sisimai::RFC5322.received(r0[0]).shift if e['lhost'].empty?
+              e['rhost'] = Sisimai::RFC5322.received(r0[-1]).pop  if e['rhost'].empty?
+            end
+            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
+              break
+            end
+
+            e['status'] = Sisimai::SMTP::Status.find(e['diagnosis'])
+            e['spec']   = 'SMTP'
+            e['action'] = 'failed' if e['status'] =~ /\A[45]/
+            e['agent']  = Sisimai::MSP::JP::Biglobe.smtpagent
+          end
+
+          return { 'ds' => dscontents, 'rfc822' => rfc822part }
+        end
+
+      end
+    end
+  end
+end

data/lib/sisimai/msp/jp/ezweb.rb

@@ -0,0 +1,292 @@
+module Sisimai
+  module MSP::JP
+    # Sisimai::MSP::JP::EZweb parses a bounce email which created by au EZweb.
+    # Methods in the module are called from only Sisimai::Message.
+    module EZweb
+      # Imported from p5-Sisimail/lib/Sisimai/MSP/JP/EZweb.pm
+      class << self
+        require 'sisimai/msp'
+        require 'sisimai/rfc5322'
+
+        Re0 = {
+          :'from'       => %r/[<]?(?>postmaster[@]ezweb[.]ne[.]jp)[>]?/i,
+          :'subject'    => %r/\AMail System Error - Returned Mail\z/,
+          :'received'   => %r/\Afrom[ ](?:.+[.])?ezweb[.]ne[.]jp[ ]/,
+          :'message-id' => %r/[@].+[.]ezweb[.]ne[.]jp[>]\z/,
+        }
+        Re1 = {
+          :begin  => %r{\A(?:
+               The[ ]user[(]s[)][ ]
+              |Your[ ]message[ ]
+              |Each[ ]of[ ]the[ ]following
+              |[<][^ ]+[@][^ ]+[>]\z
+              )
+          }x,
+          :rfc822   => %r#\A(?:[-]{50}|Content-Type:[ ]*message/rfc822)#,
+          :boundary => %r/\A__SISIMAI_PSEUDO_BOUNDARY__\z/,
+          :endof    => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+        }
+        ReFailure = {
+          #'notaccept' => [ %r/The following recipients did not receive this message:/ ],
+          'mailboxfull' => [
+              %r/The user[(]s[)] account is temporarily over quota/,
+          ],
+          'suspend' => [
+              # http://www.naruhodo-au.kddi.com/qa3429203.html
+              # The recipient may be unpaid user...?
+              %r/The user[(]s[)] account is disabled[.]/,
+              %r/The user[(]s[)] account is temporarily limited[.]/,
+          ],
+          'expired' => [
+              # Your message was not delivered within 0 days and 1 hours.
+              # Remote host is not responding.
+              %r/Your message was not delivered within /,
+          ],
+          'onhold' => [
+              %r/Each of the following recipients was rejected by a remote mail server/,
+          ],
+        }
+        Indicators = Sisimai::MSP.INDICATORS
+        LongFields = Sisimai::RFC5322.LONGFIELDS
+        RFC822Head = Sisimai::RFC5322.HEADERFIELDS
+
+        def description; return 'au EZweb: http://www.au.kddi.com/mobile/'; end
+        def smtpagent;   return 'JP::EZweb'; end
+        def headerlist;  return ['X-SPASIGN']; end
+        def pattern;     return Re0; end
+
+        # Parse bounce messages from au EZweb
+        # @param         [Hash] mhead       Message header 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['from']    =~ Re0[:from]
+          match += 1 if mhead['subject'] =~ Re0[:subject]
+          match += 1 if mhead['received'].find { |a| a =~ Re0[:received] }
+          if mhead['message-id']
+            match += 1 if mhead['message-id'] =~ Re0[:'message-id']
+          end
+          return nil if match < 2
+
+          require 'sisimai/string'
+          require 'sisimai/address'
+          dscontents = []; dscontents << Sisimai::MSP.DELIVERYSTATUS
+          hasdivided = mbody.split("\n")
+          rfc822next = { 'from' => false, 'to' => false, 'subject' => false }
+          rfc822part = ''     # (String) message/rfc822-headers part
+          previousfn = ''     # (String) Previous field name
+          readcursor = 0      # (Integer) Points the current cursor position
+          recipients = 0      # (Integer) The number of 'Final-Recipient' header
+          rxboundary = %r/\A__SISIMAI_PSEUDO_BOUNDARY__\z/
+          v = nil
+
+          if mhead['content-type']
+            # Get the boundary string and set regular expression for matching with
+            # the boundary string.
+            require 'sisimai/mime'
+            b0 = Sisimai::MIME.boundary(mhead['content-type'], 1)
+            if b0.size > 0
+              # Convert to regular expression
+              rxboundary = Regexp.new('\A' + Regexp.escape(b0) + '\z')
+            end
+          end
+          rxmessages = []
+          ReFailure.each_key { |a| rxmessages.concat(ReFailure[a]) }
+
+          hasdivided.each do |e|
+            if readcursor == 0
+              # Beginning of the bounce message or delivery status part
+              if e =~ Re1[:begin]
+                readcursor |= Indicators[:'deliverystatus']
+              end
+            end
+
+            if readcursor & Indicators[:'message-rfc822'] == 0
+              # Beginning of the original message part
+              if e =~ Re1[:rfc822] || e =~ rxboundary
+                readcursor |= Indicators[:'message-rfc822']
+                next
+              end
+            end
+
+            if readcursor & Indicators[:'message-rfc822'] > 0
+              # After "message/rfc822"
+              if cv = e.match(/\A([-0-9A-Za-z]+?)[:][ ]*.+\z/)
+                # Get required headers only
+                lhs = cv[1].downcase
+                previousfn = ''
+                next unless RFC822Head.key?(lhs)
+
+                previousfn  = lhs
+                rfc822part += e + "\n"
+
+              elsif e =~ /\A[ \t]+/
+                # Continued line from the previous line
+                next if rfc822next[previousfn]
+                rfc822part += e + "\n" if LongFields.key?(previousfn)
+
+              else
+                # Check the end of headers in rfc822 part
+                next unless LongFields.key?(previousfn)
+                next unless e.empty?
+                rfc822next[previousfn] = true
+              end
+
+            else
+              # Before "message/rfc822"
+              next if readcursor & Indicators[:'deliverystatus'] == 0
+              next if e.empty?
+
+              # The user(s) account is disabled.
+              #
+              # <***@ezweb.ne.jp>: 550 user unknown (in reply to RCPT TO command)
+              #
+              #  -- OR --
+              # Each of the following recipients was rejected by a remote
+              # mail server.
+              #
+              #    Recipient: <******@ezweb.ne.jp>
+              #    >>> RCPT TO:<******@ezweb.ne.jp>
+              #    <<< 550 <******@ezweb.ne.jp>: User unknown
+              v = dscontents[-1]
+
+              if cv = e.match(/\A[<]([^ ]+[@][^ ]+)[>]\z/) ||
+                 cv = e.match(/\A[<]([^ ]+[@][^ ]+)[>]:?(.*)\z/) ||
+                 cv = e.match(/\A[ \t]+Recipient: [<]([^ ]+[@][^ ]+)[>]/)
+
+                if v['recipient']
+                  # There are multiple recipient addresses in the message body.
+                  push dscontents << Sisimai::MSP.DELIVERYSTATUS
+                  v = dscontents[-1]
+                end
+
+                r = Sisimai::Address.s3s4(cv[1])
+                if Sisimai::RFC5322.is_emailaddress(r)
+                  v['recipient'] = r
+                  recipients += 1
+                end
+
+              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[Aa]ction:[ ]*(.+)\z/)
+                # Action: failed
+                v['action'] = cv[1].downcase
+
+              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
+                v['date'] = cv[1]
+
+              else
+                next if Sisimai::String.is_8bit(e)
+                if cv = e.match(/\A[ \t]+[>]{3}[ \t]+([A-Z]{4})/)
+                  #    >>> RCPT TO:<******@ezweb.ne.jp>
+                  v['command'] = cv[1]
+
+                else
+                  # Check error message
+                  if rxmessages.find { |a| e =~ a }
+                    # Check with regular expressions of each error
+                    v['diagnosis'] ||= ''
+                    v['diagnosis']  += ' ' + e
+
+                  else
+                    # >>> 550
+                    v['alterrors'] ||= ''
+                    v['alterrors']  += ' ' + e
+                  end
+                end
+              end
+            end
+          end
+
+          return nil if recipients == 0
+          require 'sisimai/smtp/status'
+
+          dscontents.map do |e|
+            if mhead['received'].size > 0
+              # Get localhost and remote host name from Received header.
+              r0 = mhead['received']
+              ['lhost', 'rhost'].each { |a| e[a] ||= '' }
+              e['lhost'] = Sisimai::RFC5322.received(r0[0]).shift if e['lhost'].empty?
+              e['rhost'] = Sisimai::RFC5322.received(r0[-1]).pop  if e['rhost'].empty?
+            end
+
+            if e['alterrors'] && e['alterrors'].size > 0
+              # Copy alternative error message
+              e['diagnosis'] ||= e['alterrors']
+              if e['diagnosis'] =~ /\A[-]+/ || e['diagnosis'] =~ /__\z/
+                # Override the value of diagnostic code message
+                e['diagnosis'] = e['alterrors'] if e['alterrors'].size > 0
+              end
+              e.delete('alterrors')
+            end
+            e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+
+            if mhead['x-spasign'] && mhead['x-spasign'] == 'NG'
+              # Content-Type: text/plain; ..., X-SPASIGN: NG (spamghetti, au by EZweb)
+              # Filtered recipient returns message that include 'X-SPASIGN' header
+              e['reason'] = 'filtered'
+
+            else
+              if e['command'] == 'RCPT'
+                # set "userunknown" when the remote server rejected after RCPT
+                # command.
+                e['reason'] = 'userunknown'
+              else
+                # SMTP command is not RCPT
+                catch :SESSION do
+                  ReFailure.each_key do |r|
+                    # Verify each regular expression of session errors
+                    ReFailure[r].each do |rr|
+                      # Check each regular expression
+                      next unless e['diagnosis'] =~ rr
+                      e['reason'] = r
+                      throw :SESSION
+                    end
+                  end
+                end
+
+              end
+            end
+
+            unless e['reason']
+              # The value of "reason" is not set yet.
+              unless e['recipient'] =~ /[@]ezweb[.]ne[.]jp\z/
+                # Deal as "userunknown" when the domain part of the recipient
+                # is "ezweb.ne.jp".
+                e['reason'] = 'userunknown'
+              end
+            end
+
+            e['status'] = Sisimai::SMTP::Status.find(e['diagnosis'])
+            e['spec']   = 'SMTP'
+            e['action'] = 'failed' if e['status'] =~ /\A[45]/
+            e['agent']  = Sisimai::MSP::JP::EZweb.smtpagent
+          end
+
+          return { 'ds' => dscontents, 'rfc822' => rfc822part }
+        end
+
+      end
+    end
+  end
+end