sisimai 4.21.1 → 4.22.0

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

@@ -0,0 +1,167 @@
+module Sisimai::Bite::Email
+  module Zoho
+    # Sisimai::Bite::Email::Zoho parses a bounce email which created by Zoho Mail.
+    # Methods in the module are called from only Sisimai::Message.
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/Zoho.pm
+      require 'sisimai/bite/email'
+
+      Re0 = {
+        :'from'     => %r/mailer-daemon[@]mail[.]zoho[.]com\z/,
+        :'subject'  => %r{\A(?:
+             Undelivered[ ]Mail[ ]Returned[ ]to[ ]Sender
+            |Mail[ ]Delivery[ ]Status[ ]Notification
+            )
+        }x,
+        :'x-mailer' => %r/\AZoho Mail\z/,
+      }
+      Re1 = {
+        :begin  => %r/\AThis message was created automatically by mail delivery/,
+        :rfc822 => %r/\AReceived:[ \t]*from mail[.]zoho[.]com/,
+        :endof  => %r/\A__END_OF_EMAIL_MESSAGE__\z/,
+      }
+      ReFailure = {
+        expired: %r/Host not reachable/
+      }
+      Indicators = Sisimai::Bite::Email.INDICATORS
+
+      def description; return 'Zoho Mail: https://www.zoho.com'; end
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+
+      # X-ZohoMail: Si CHF_MF_NL SS_10 UW48 UB48 FMWL UW48 UB48 SGR3_1_09124_42
+      # X-Zoho-Virus-Status: 2
+      # X-Mailer: Zoho Mail
+      def headerlist;  return ['X-ZohoMail']; end
+      def pattern;     return Re0; end
+
+      # Parse bounce messages from Zoho 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-zohomail']
+
+        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
+        qprintable = false
+        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?
+
+            # This message was created automatically by mail delivery software.
+            # A message that you sent could not be delivered to one or more of its recip=
+            # ients. This is a permanent error.=20
+            #
+            # kijitora@example.co.jp Invalid Address, ERROR_CODE :550, ERROR_CODE :5.1.=
+            # 1 <kijitora@example.co.jp>... User Unknown
+
+            # 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.
+            #
+            # shironeko@example.org Invalid Address, ERROR_CODE :550, ERROR_CODE :Requested action not taken: mailbox unavailable
+            v = dscontents[-1]
+
+            if cv = e.match(/\A([^ ]+[@][^ ]+)[ \t]+(.+)\z/)
+              # kijitora@example.co.jp Invalid Address, ERROR_CODE :550, ERROR_CODE :5.1.=
+              if v['recipient']
+                # There are multiple recipient addresses in the message body.
+                dscontents << Sisimai::Bite.DELIVERYSTATUS
+                v = dscontents[-1]
+              end
+              v['recipient'] = cv[1]
+              v['diagnosis'] = cv[2]
+
+              if v['diagnosis'] =~ /=\z/
+                # Quoted printable
+                v['diagnosis'] = v['diagnosis'].sub(/=\z/, '')
+                qprintable = true
+              end
+              recipients += 1
+
+            elsif cv = e.match(/\A\[Status: .+[<]([^ ]+[@][^ ]+)[>],/)
+              # Expired
+              # [Status: Error, Address: <kijitora@6kaku.example.co.jp>, ResponseCode 421, , Host not reachable.]
+              if v['recipient']
+                # There are multiple recipient addresses in the message body.
+                dscontents << Sisimai::Bite.DELIVERYSTATUS
+                v = dscontents[-1]
+              end
+              v['recipient'] = cv[1]
+              v['diagnosis'] = e
+              recipients += 1
+
+            else
+              # Continued line
+              next unless qprintable
+              v['diagnosis'] ||= ''
+              v['diagnosis']  += e
+
+            end
+          end
+        end
+        return nil if recipients.zero?
+        require 'sisimai/string'
+
+        dscontents.map do |e|
+          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
+        end
+
+        rfc822part = Sisimai::RFC5322.weedout(rfc822list)
+        return { 'ds' => dscontents, 'rfc822' => rfc822part }
+      end
+
+    end
+  end
+end
+

data/lib/sisimai/bite/json.rb

@@ -0,0 +1,38 @@
+module Sisimai
+  module Bite
+    module JSON
+      # Sisimai::Bite::JSON - Base class for Sisimai::Bite::JSON::*
+      class << self
+        # Imported from p5-Sisimail/lib/Sisimai/Bite/JSON.pm
+        require 'sisimai/bite'
+        require 'sisimai/rfc5322'
+
+        def headerlist; return []; end
+        def pattern;    return []; end
+
+        # MTA list
+        # @return   [Array] MTA list with order
+        def index
+          return %w|SendGrid AmazonSES|
+        end
+
+        # Convert from JSON object to Sisimai::Message
+        # @param         [Hash] mhead       Message header of a bounce email
+        # @param         [String] mbody     Message body of a bounce email(JSON)
+        # @return        [Hash, Undef]      Bounce data list and message/rfc822 part
+        #                                   or Undef if it failed to parse or the
+        #                                   arguments are missing
+        def scan; return nil; end
+
+        # @abstract      Adapt bounce object for Sisimai::Message format
+        # @param         [Hash] argvs       bounce object returned from each email cloud
+        # @return        [Hash, Undef]      Bounce data list and message/rfc822 part
+        #                                   or Undef if it failed to parse or the
+        #                                   arguments are missing
+        def adapt; return nil; end
+
+      end
+    end
+  end
+end
+

data/lib/sisimai/bite/json/amazonses.rb

@@ -0,0 +1,255 @@
+module Sisimai::Bite::JSON
+  # Sisimai::Bite::JSON::AmazonSES parses a bounce object(JSON) which created
+  # by Amazon Simple Email Service.
+  # Methods in the module are called from only Sisimai::Message.
+  module AmazonSES
+    # Imported from p5-Sisimail/lib/Sisimai/Bite/JSON/AmazonSES.pm
+    class << self
+      require 'sisimai/bite/json'
+
+      # https://docs.aws.amazon.com/en_us/ses/latest/DeveloperGuide/notification-contents.html
+      BounceType = {
+        :Permanent => {
+          :General    => '',
+          :NoEmail    => '',
+          :Suppressed => '',
+        },
+        :Transient => {
+          :General            => '',
+          :MailboxFull        => 'mailboxfull',
+          :MessageTooLarge    => 'mesgtoobig',
+          :ContentRejected    => '',
+          :AttachmentRejected => '',
+        },
+      }
+
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def description; return 'Amazon SES(JSON): http://aws.amazon.com/ses/'; end
+
+      # Parse bounce messages from Amazon SES(JSON)
+      # @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
+      # @since v4.20.0
+      def scan(mhead, mbody)
+        return nil unless mhead
+        return nil unless mbody
+        return nil unless mhead['x-amz-sns-message-id']
+        return nil unless mhead['x-amz-sns-message-id'].size > 0
+
+        hasdivided = mbody.split("\n")
+        jsonstring = ''
+        jsonthings = nil
+        foldedline = false
+
+        hasdivided.each do |e|
+          # Find JSON string from the message body
+          next if e.size.zero?
+          break if e =~ /\A[-]{2}\z/
+          break if e == '__END_OF_EMAIL_MESSAGE__'
+
+          # The line starts with " ", continued from !\n.
+          e = e.sub(/\A[ ]/, '') if foldedline
+          foldedline = false
+
+          if e =~ /[!]\z/
+            # ... long long line ...![\n]
+            e = e.sub(/!\z/, '')
+            foldedline = true
+          end
+          jsonstring += e
+        end
+
+        begin
+          if RUBY_PLATFORM =~ /java/
+            # java-based ruby environment like JRuby.
+            require 'jrjackson'
+            jsonobject = JrJackson::Json.load(jsonstring)
+            if jsonobject['Message']
+              # 'Message' => '{"notificationType":"Bounce",...
+              jsonthings = JrJackson::Json.load(jsonobject['Message'])
+            end
+          else
+            # Matz' Ruby Implementation
+            require 'oj'
+            jsonobject = Oj.load(jsonstring)
+            if jsonobject['Message']
+              # 'Message' => '{"notificationType":"Bounce",...
+              jsonthings = Oj.load(jsonobject['Message'])
+            end
+          end
+          jsonthings ||= jsonobject
+
+        rescue StandardError => ce
+          # Something wrong in decoding JSON
+          warn sprintf(' ***warning: Failed to decode JSON: %s', ce.to_s)
+          return nil
+        end
+
+        return adapt(jsonthings)
+      end
+
+      # @abstract Adapt Amazon SES bounce object for Sisimai::Message format
+      # @param        [Hash] argvs  bounce object(JSON) retrieved from Amazon SNS
+      # @return       [Hash, Nil]   Bounce data list and message/rfc822 part
+      #                             or Undef if it failed to parse or the
+      #                             arguments are missing
+      # @since v4.20.0
+      def adapt(argvs)
+        return nil unless argvs.is_a? Hash
+        return nil unless argvs.keys.size > 0
+        return nil unless argvs.key?('notificationType')
+
+        require 'sisimai/rfc5322'
+        dscontents = [Sisimai::Bite.DELIVERYSTATUS]
+        rfc822head = {}   # (Hash) Check flags for headers in RFC822 part
+        recipients = 0    # (Integer) The number of 'Final-Recipient' header
+        labeltable = {
+          :Bounce    => 'bouncedRecipients',
+          :Complaint => 'complainedRecipients',
+        }
+        v = nil
+
+        if argvs['notificationType'] =~ /\A(?:Bounce|Complaint)\z/
+          # { "notificationType":"Bounce", "bounce": { "bounceType":"Permanent",...
+          o = argvs[ argvs['notificationType'].downcase ]
+          r = o[ labeltable[ argvs['notificationType'].to_sym ] ] || []
+
+          r.each do |e|
+            # 'bouncedRecipients' => [ { 'emailAddress' => 'bounce@si...' }, ... ]
+            # 'complainedRecipients' => [ { 'emailAddress' => 'complaint@si...' }, ... ]
+            next unless Sisimai::RFC5322.is_emailaddress(e['emailAddress'])
+
+            v = dscontents[-1]
+            if v['recipient']
+              # There are multiple recipient addresses in the message body.
+              dscontents << Sisimai::Bite.DELIVERYSTATUS
+              v = dscontents[-1]
+            end
+            recipients += 1
+            v['recipient'] = e['emailAddress']
+
+            if argvs['notificationType'] == 'Bounce'
+              # 'bouncedRecipients => [ {
+              #   'emailAddress' => 'bounce@simulator.amazonses.com',
+              #   'action' => 'failed',
+              #   'status' => '5.1.1',
+              #   'diagnosticCode' => 'smtp; 550 5.1.1 user unknown'
+              # }, ... ]
+              v['action'] = e['action']
+              v['status'] = e['status']
+
+              if cv = e['diagnosticCode'].match(/\A(.+?);[ ]*(.+)\z/)
+                # Diagnostic-Code: SMTP; 550 5.1.1 <userunknown@example.jp>... User Unknown
+                v['spec'] = cv[1].upcase
+                v['diagnosis'] = cv[2]
+              else
+                v['diagnosis'] = e['diagnosticCode']
+              end
+
+              if cv = o['reportingMTA'].match(/\Adsn;[ ](.+)\z/)
+                # 'reportingMTA' => 'dsn; a27-23.smtp-out.us-west-2.amazonses.com',
+                v['lhost'] = cv[1]
+              end
+
+              if BounceType.key?(o['bounceType'].to_sym) &&
+                 BounceType[o['bounceType'].to_sym].key?(o['bounceSubType'].to_sym)
+                  # 'bounce' => {
+                  #       'bounceType' => 'Permanent',
+                  #       'bounceSubType' => 'General'
+                  # },
+                  v['reason'] = BounceType[o['bounceType'].to_sym][o['bounceSubType'].to_sym]
+              end
+
+            else
+              # 'complainedRecipients' => [ {
+              #   'emailAddress' => 'complaint@simulator.amazonses.com' }, ... ],
+              v['reason'] = 'feedback'
+              v['feedbacktype'] = o['complaintFeedbackType'] || ''
+            end
+
+            v['date'] = o['timestamp'] || argvs['mail']['timestamp']
+            v['date'] = v['date'].sub(/[.]\d+Z\z/, '')
+          end
+
+        elsif argvs['notificationType'] == 'Delivery'
+          # { "notificationType":"Delivery", "delivery": { ...
+          require 'sisimai/smtp/status'
+          require 'sisimai/smtp/reply'
+
+          o = argvs['delivery']
+          r = o['recipients'] || []
+
+          r.each do |e|
+            # 'delivery' => {
+            #       'timestamp' => '2016-11-23T12:01:03.512Z',
+            #       'processingTimeMillis' => 3982,
+            #       'reportingMTA' => 'a27-29.smtp-out.us-west-2.amazonses.com',
+            #       'recipients' => [
+            #           'success@simulator.amazonses.com'
+            #       ],
+            #       'smtpResponse' => '250 2.6.0 Message received'
+            #   },
+            next unless Sisimai::RFC5322.is_emailaddress(e)
+
+            v = dscontents[-1]
+            if v['recipient']
+              # There are multiple recipient addresses in the message body.
+              dscontents << Sisimai::Bite.DELIVERYSTATUS
+              v = dscontents[-1]
+            end
+            recipients += 1
+            v['recipient'] = e
+            v['lhost']     = o['reportingMTA'] || ''
+            v['diagnosis'] = o['smtpResponse'] || ''
+            v['status']    = Sisimai::SMTP::Status.find(v['diagnosis'])
+            v['replycode'] = Sisimai::SMTP::Reply.find(v['diagnosis'])
+            v['reason']    = 'delivered'
+            v['action']    = 'deliverable'
+
+            v['date'] = o['timestamp'] || argvs['mail']['timestamp']
+            v['date'] = v['date'].sub(/[.]\d+Z\z/, '')
+          end
+
+        else
+          # The value of "notificationType" is not any of "Bounce", "Complaint",
+          # or "Delivery".
+          return nil
+        end
+        return nil if recipients.zero?
+
+        dscontents.each do |e|
+          e['agent'] = self.smtpagent
+        end
+
+        if argvs['mail']['headers']
+          # "headersTruncated":false,
+          # "headers":[ { ...
+          argvs['mail']['headers'].each do |e|
+            # 'headers' => [ { 'name' => 'From', 'value' => 'neko@nyaan.jp' }, ... ],
+            next unless e['name'] =~ /\A(?:From|To|Subject|Message-ID|Date)\z/
+            rfc822head[ e['name'].downcase ] = e['value']
+          end
+        end
+
+        unless rfc822head['message-id']
+          # Try to get the value of "Message-Id".
+          if argvs['mail']['messageId']
+            # 'messageId' => '01010157e48f9b9b-891e9a0e-9c9d-4773-9bfe-608f2ef4756d-000000'
+            rfc822head['message-id'] = argvs['mail']['messageId']
+          end
+        end
+        return { 'ds' => dscontents, 'rfc822' => rfc822head }
+      end
+
+    end
+  end
+end
+