sisimai 4.14.2

data/lib/sisimai/mime.rb

@@ -0,0 +1,127 @@
+module Sisimai
+  # Sisimai::MIME is MIME Utilities for Sisimai.
+  module MIME
+    # Imported from p5-Sisimail/lib/Sisimai/MIME.pm
+    class << self
+      require 'base64'
+
+      # Check that the argument is MIME-Encoded string or not
+      # @param    [String] argvs  String to be checked
+      # @return   [True,False]    false: Not MIME encoded string
+      #                           true:  MIME encoded string
+      def is_mimeencoded(argv1)
+        return false unless argv1
+
+        argv1 = argv1.delete('"')
+        return true if argv1 =~ /[ \t]*=[?][-_0-9A-Za-z]+[?][BbQq][?].+[?]=[ \t]*\z/
+        return false
+      end
+
+      # Decode MIME-Encoded string
+      # @param    [Array] argvs   Reference to an array including MIME-Encoded text
+      # @return   [String]        MIME-Decoded text
+      def mimedecode(argvs = [])
+        return '' unless argvs
+        return '' unless argvs.is_a? Array
+
+        characterset = nil
+        encodingname = nil
+        mimeencoded0 = nil
+        decodedtext0 = []
+
+        argvs.each do |e|
+          # Check and decode each element
+          e = e.lstrip.rstrip
+          e = e.delete('"')
+
+          if self.is_mimeencoded(e)
+            # MIME Encoded string
+            if cv = e.match(/\A=[?]([-_0-9A-Za-z]+)[?]([BbQq])[?](.+)[?]=\z/)
+              # =?utf-8?B?55m954yr44Gr44KD44KT44GT?=
+              characterset ||= cv[1]
+              encodingname ||= cv[2]
+              mimeencoded0   = cv[3]
+
+              if encodingname == 'Q'
+                # Quoted-Printable
+                decodedtext0 << mimeencoded0.unpack('M').first
+
+              elsif encodingname == 'B'
+                # Base64
+                decodedtext0 << Base64.decode64(mimeencoded0)
+              end
+            end
+          else
+            decodedtext0 << e
+          end
+        end
+
+        return '' unless decodedtext0.size > 0
+        decodedtext1 = decodedtext0.join('')
+
+        if characterset && encodingname
+          # utf8 => UTF-8
+          characterset = 'UTF-8' if characterset.upcase == 'UTF8'
+
+          if characterset.upcase != 'UTF-8'
+            # Characterset is not UTF-8
+            begin
+              decodedtext1 = decodedtext1.encode('UTF-8', characterset)
+            rescue
+              decodedtext1 = 'FAILED TO CONVERT THE SUBJECT'
+            end
+          end
+        end
+
+        return decodedtext1.force_encoding('UTF-8')
+      end
+
+      # Decode MIME Quoted-Printable Encoded string
+      # @param  [String] argv1   MIME Encoded text
+      # @return [String]         MIME Decoded text
+      def qprintd(argv1)
+        return nil unless argv1
+        return argv1.unpack('M').first
+      end
+
+      # Decode MIME BASE64 Encoded string
+      # @param  [String] argv1   MIME Encoded text
+      # @return [String]         MIME-Decoded text
+      def base64d(argv1)
+        return nil unless argv1
+
+        plain = nil
+        if cv = argv1.match(%r|([+/\=0-9A-Za-z\r\n]+)|)
+          # Decode BASE64
+          plain = Base64.decode64(cv[1])
+        end
+        return plain.force_encoding('UTF-8')
+      end
+
+      # Get boundary string
+      # @param    [String]  argv1 The value of Content-Type header
+      # @param    [Integer] start -1: boundary string itself
+      #                            0: Start of boundary
+      #                            1: End of boundary
+      # @return   [String] Boundary string
+      def boundary(argv1 = nil, start = -1)
+        return nil unless argv1
+        value = nil
+
+        if cv = argv1.match(/\bboundary=([^ ]+)/)
+          # Content-Type: multipart/mixed; boundary=Apple-Mail-5--931376066
+          # Content-Type: multipart/report; report-type=delivery-status;
+          #    boundary="n6H9lKZh014511.1247824040/mx.example.jp"
+          value = cv[1]
+          value = value.delete(%q|'"|)
+        end
+
+        value = sprintf( '--%s', value ) if start > -1
+        value = sprintf( '%s--', value ) if start >  0
+        return value
+      end
+    end
+
+  end
+end
+

data/lib/sisimai/msp.rb

@@ -0,0 +1,54 @@
+module Sisimai
+  # Sisimai::MSP - Base class for Sisimai::MSP::*, Mail Service Provider classes.
+  module MSP
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/MSP.pm
+      require 'sisimai/rfc5322'
+
+      # Flags for position variable for
+      # @return   [Hash] Position flag data
+      # @private
+      def INDICATORS
+        return {
+          :'deliverystatus' => ( 1 << 1 ),
+          :'message-rfc822' => ( 1 << 2 ),
+        }
+      end
+
+      # Data structure for parsed bounce messages
+      # @return [Hash] Data structure for delivery status
+      # @private
+      def DELIVERYSTATUS
+        return {
+          'spec'         => nil,  # Protocl specification
+          'date'         => nil,  # The value of Last-Attempt-Date header
+          'rhost'        => nil,  # The value of Remote-MTA header
+          'lhost'        => nil,  # The value of Received-From-MTA header
+          'alias'        => nil,  # The value of alias entry(RHS)
+          'agent'        => nil,  # MTA name
+          'action'       => nil,  # The value of Action header
+          'status'       => nil,  # The value of Status header
+          'reason'       => nil,  # Temporary reason of bounce
+          'command'      => nil,  # SMTP command in the message body
+          'diagnosis'    => nil,  # The value of Diagnostic-Code header
+          'recipient'    => nil,  # The value of Final-Recipient header
+          'softbounce'   => nil,  # Soft bounce or not
+          'feedbacktype' => nil,  # FeedBack Type
+        }
+      end
+
+      # MSP list
+      # @return   [Array] MSP list with order
+      def index
+        return [
+          'US::Google', 'US::Yahoo', 'US::Aol', 'US::Outlook', 'US::AmazonSES',
+          'US::SendGrid', 'US::Verizon', 'RU::MailRu', 'RU::Yandex', 'DE::GMX',
+          'US::Bigfoot', 'US::Facebook', 'US::Zoho', 'DE::EinsUndEins',
+          'UK::MessageLabs', 'JP::EZweb', 'JP::KDDI', 'JP::Biglobe',
+          'US::ReceivingSES',
+        ]
+      end
+
+    end
+  end
+end

data/lib/sisimai/msp/de/einsundeins.rb

@@ -0,0 +1,174 @@
+module Sisimai
+  module MSP::DE
+    # Sisimai::MSP::DE::EinsUndEins parses a bounce email which created by 1&1.
+    # Methods in the module are called from only Sisimai::Message.
+    module EinsUndEins
+      # Imported from p5-Sisimail/lib/Sisimai/MSP/DE/EinsUndEins.pm
+      class << self
+        require 'sisimai/msp'
+        require 'sisimai/rfc5322'
+
+        Re0 = {
+          :from    => %r/\A["]Mail Delivery System["]/,
+          :subject => %r/\AMail delivery failed: returning message to sender\z/,
+        }
+        Re1 = {
+          :begin   => %r/\AThis message was created automatically by mail delivery software/,
+          :error   => %r/\AFor the following reason:/,
+          :rfc822  => %r/\A--- The header of the original message is following/,
+          :endof   => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+        }
+        ReFailure = {
+          'mesgtoobig' => %r/Mail[ ]size[ ]limit[ ]exceeded/x,
+        }
+        Indicators = Sisimai::MSP.INDICATORS
+        LongFields = Sisimai::RFC5322.LONGFIELDS
+        RFC822Head = Sisimai::RFC5322.HEADERFIELDS
+
+        def description; return '1&1: http://www.1and1.de'; end
+        def smtpagent;   return 'DE::EinsUndEins'; end
+        # X-UI-Out-Filterresults: unknown:0;
+        def headerlist;  return []; end
+        def pattern;     return Re0; end
+
+        # Parse bounce messages from 1&1
+        # @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]
+
+          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?
+
+              # The following address failed:
+              #
+              # general@example.eu
+              #
+              # For the following reason:
+              #
+              # Mail size limit exceeded. For explanation visit
+              # http://postmaster.1and1.com/en/error-messages?ip=%1s
+              v = dscontents[-1]
+
+              if cv = e.match(/\A([^ ]+[@][^ ]+)\z/)
+                # general@example.eu
+                if v['recipient']
+                  # There are multiple recipient addresses in the message body.
+                  dscontents << Sisimai::MSP.DELIVERYSTATUS
+                  v = dscontents[-1]
+                end
+                v['recipient'] = cv[1]
+                recipients += 1
+
+              elsif e =~ Re1[:error]
+                # For the following reason:
+                v['diagnosis'] = e
+
+              else
+                # Get error message
+                if v['diagnosis']
+                  # Append error message strings
+                  v['diagnosis'] += ' ' + e
+                end
+              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'] ||= ''
+            e['diagnosis']   = e['diagnosis'].gsub(/\A#{Re1[:error]}/, '')
+            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['agent']  = Sisimai::MSP::DE::EinsUndEins.smtpagent
+          end
+
+          return { 'ds' => dscontents, 'rfc822' => rfc822part }
+        end
+
+      end
+    end
+  end
+end
+

data/lib/sisimai/msp/de/gmx.rb

@@ -0,0 +1,197 @@
+module Sisimai
+  module MSP::DE
+    # Sisimai::MSP::DE::GMX parses a bounce email which created by GMX. Methods
+    # in the module are called from only Sisimai::Message.
+    module GMX
+      # Imported from p5-Sisimail/lib/Sisimai/MSP/DE/GMX.pm
+      class << self
+        require 'sisimai/msp'
+        require 'sisimai/rfc5322'
+
+        Re0 = {
+          :from    => %r/\AMAILER-DAEMON[@]/,
+          :subject => %r/\AMail delivery failed: returning message to sender\z/,
+        }
+        Re1 = {
+          :begin   => %r/\AThis message was created automatically by mail delivery software/,
+          :rfc822  => %r/\A--- The header of the original message is following/,
+          :endof   => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+        }
+        ReFailure = {
+          'expired' => %r/delivery[ ]retry[ ]timeout[ ]exceeded/x,
+        }
+        Indicators = Sisimai::MSP.INDICATORS
+        LongFields = Sisimai::RFC5322.LONGFIELDS
+        RFC822Head = Sisimai::RFC5322.HEADERFIELDS
+
+        def description; return 'GMX: http://www.gmx.net'; end
+        def smtpagent;   return 'DE::GMX'; end
+
+        # Envelope-To: <kijitora@mail.example.com>
+        # X-GMX-Antispam: 0 (Mail was not recognized as spam); Detail=V3;
+        # X-GMX-Antivirus: 0 (no virus found)
+        # X-UI-Out-Filterresults: unknown:0;
+        def headerlist;  return ['X-GMX-Antispam']; end
+        def pattern;     return Re0; end
+
+        # Parse bounce messages from GMX
+        # @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['x-gmx-antispam'];
+
+          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 message was created automatically by mail delivery software.
+              #
+              # A message that you sent could not be delivered to one or more of
+              # its recipients. This is a permanent error. The following address
+              # failed:
+              #
+              # "shironeko@example.jp":
+              # SMTP error from remote server after RCPT command:
+              # host: mx.example.jp
+              # 5.1.1 <shironeko@example.jp>... User Unknown
+              v = dscontents[-1]
+
+              if cv = e.match(/\A["]([^ ]+[@][^ ]+)["]:\z/) ||
+                 cv = e.match(/\A[<]([^ ]+[@][^ ]+)[>]\z/)
+                # "shironeko@example.jp":
+                # ---- OR ----
+                # <kijitora@6jo.example.co.jp>
+                #
+                # Reason:
+                # delivery retry timeout exceeded
+                if v['recipient']
+                  # There are multiple recipient addresses in the message body.
+                  dscontents << Sisimai::MSP.DELIVERYSTATUS
+                  v = dscontents[-1]
+                end
+                v['recipient'] = cv[1]
+                recipients += 1
+
+              elsif cv = e.match(/\ASMTP error .+ ([A-Z]{4}) command:\z/)
+                # SMTP error from remote server after RCPT command:
+                v['command'] = cv[1]
+
+              elsif cv = e.match(/\Ahost:[ \t]*(.+)\z/)
+                # host: mx.example.jp
+                v['rhost'] = cv[1]
+
+              else
+                # Get error message
+                if e =~ /\b[45][.]\d[.]\d\b/ || e =~ /[<][^ ]+[@][^ ]+[>]/ || e =~ /\b[45]\d{2}\b/
+                  v['diagnosis'] ||= e;
+
+                else
+                  next if e =~ /\A\z/
+                  if e =~ /\AReason:\z/
+                    # Reason:
+                    # delivery retry timeout exceeded
+                    v['diagnosis'] = e
+
+                  elsif v['diagnosis'] =~ /\AReason:\z/
+                    v['diagnosis'] = e
+                  end
+                end
+              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'] = 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
+              break
+            end
+
+            e['status'] = Sisimai::SMTP::Status.find(e['diagnosis'])
+            e['spec']   = 'SMTP'
+            e['agent']  = Sisimai::MSP::DE::GMX.smtpagent
+          end
+
+          return { 'ds' => dscontents, 'rfc822' => rfc822part }
+        end
+
+      end
+    end
+  end
+end
+