sisimai 4.21.1-java → 4.22.0-java

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

@@ -0,0 +1,79 @@
+module Sisimai::Bite::JSON
+  # Sisimai::Bite::JSON::SendGrid parses a bounce object(JSON) which created by
+  # SendGrid. Methods in the module are called from only Sisimai::Message.
+  module SendGrid
+    # Imported from p5-Sisimail/lib/Sisimai/Bite/JSON/SendGrid.pm
+    class << self
+      require 'sisimai/bite/json'
+
+      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def description; return 'SendGrid(JSON): http://sendgrid.com/'; end
+
+      # @abstract Adapt SendGrid bounce object for Sisimai::Message format
+      # @param        [Hash] argvs  bounce object(JSON) retrieved from SendGrid API
+      # @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?('email')
+
+        dscontents = [Sisimai::Bite.DELIVERYSTATUS]
+        rfc822head = {}     # (Hash) Check flags for headers in RFC822 part
+        recipients = 0      # (Integer) The number of 'Final-Recipient' header
+        v = dscontents[-1]
+
+        require 'sisimai/string'
+        require 'sisimai/address'
+
+        if Sisimai::RFC5322.is_emailaddress(argvs['email'])
+          #   {
+          #       "status": "4.0.0",
+          #       "created": "2011-09-16 22:02:19",
+          #       "reason": "Unable to resolve MX host sendgrid.ne",
+          #       "email": "esting@sendgrid.ne"
+          #   },
+          recipients += 1
+          v['recipient'] = argvs['email']
+          v['date'] = argvs['created'] || ''
+
+          statuscode = argvs['status']  || ''
+          diagnostic = Sisimai::String.sweep(argvs['reason']) || ''
+
+          if statuscode =~ /\A[245]\d\d\z/
+            # "status": "550"
+            v['replycode'] = statuscode
+
+          elsif statuscode =~ /\A[245][.]\d[.]\d+\z/
+            # "status": "5.1.1"
+            v['status'] = statuscode
+          end
+
+          require 'sisimai/smtp/reply'
+          require 'sisimai/smtp/status'
+          v['status']    ||= Sisimai::SMTP::Status.find(diagnostic)
+          v['replycode'] ||= Sisimai::SMTP::Reply.find(diagnostic)
+          v['diagnosis']   = argvs['reason'] || ''
+          v['agent']       = self.smtpagent
+
+          # Generate pseudo message/rfc822 part
+          rfc822head = {
+            'to'   => argvs['email'],
+            'from' => Sisimai::Address.undisclosed('s'),
+            'date' => v['date'],
+          }
+        else
+          # The value of $argvs->{'email'} does not seems to an email address
+          return nil
+        end
+
+        return nil if recipients.zero?
+        return { 'ds' => dscontents, 'rfc822' => rfc822head }
+      end
+
+    end
+  end
+end
+

data/lib/sisimai/ced.rb

@@ -5,16 +5,40 @@ module Sisimai
       # Imported from p5-Sisimail/lib/Sisimai/CED.pm
       require 'sisimai/skeleton'
 
-      def INDICATORS;        return Sisimai::Skeleton.INDICATORS;     end
-      def DELIVERYSTATUS;    return Sisimai::Skeleton.DELIVERYSTATUS; end
-      def smtpagent(v = ''); return v.to_s.sub(/\ASisimai::/, '');    end
-      def description;       return ''; end
-      def headerlist;        return []; end
-      def pattern;           return {}; end
+      def INDICATORS
+        warn ' ***warning: Sisimai::CED->INDICATORS has been moved to Sisimai::Bite::Email->INDICATORS'
+        return Sisimai::Skeleton.INDICATORS
+      end
+
+      def DELIVERYSTATUS
+        warn ' ***warning: Sisimai::CED->DELIVERYSTATUS has been moved to Sisimai::Bite->DELIVERYSTATUS'
+        return Sisimai::Skeleton.DELIVERYSTATUS
+      end
+
+      def smtpagent(v = '')
+        warn ' ***warning: Sisimai::CED->smtpagent has been moved to Sisimai::Bite->smtpagent'
+        return v.to_s.sub(/\ASisimai::/, '')
+      end
+
+      def description
+        warn ' ***warning: Sisimai::CED->description has been moved to Sisimai::Bite->description'
+        return ''
+      end
+
+      def headerlist
+        warn ' ***warning: Sisimai::CED->headerlist has been moved to Sisimai::Bite::Email->headerlist'
+        return []
+      end
+
+      def pattern
+        warn ' ***warning: Sisimai::CED->pattern has been moved to Sisimai::Bite::Email->pattern'
+        return {}
+      end
 
       # CED list
       # @return   [Array] CED list with order
       def index
+        warn ' ***warning: Sisimai::CED->index has been moved to Sisimai::Bite::Email->index'
         return ['US::AmazonSES', 'US::SendGrid']
       end
 

data/lib/sisimai/data.rb

@@ -28,7 +28,7 @@ module Sisimai
       :recipient,       # [Sisimai::Address] Recipient address which bounced
       :messageid,       # [String] Message-Id: header
       :replycode,       # [String] SMTP Reply Code
-      :smtpagent,       # [String] MTA name
+      :smtpagent,       # [String] Module(Engine) name
       :softbounce,      # [Integer] 1 = Soft bounce, 0 = Hard bounce, -1 = ?
       :smtpcommand,     # [String] The last SMTP command
       :destination,     # [String] The domain part of the "recipinet"
@@ -61,18 +61,18 @@ module Sisimai
       thing = {}
 
       # Create email address object
-      x0 = Sisimai::Address.parse([argvs['addresser']])
-      y0 = Sisimai::Address.parse([argvs['recipient']])
+      x0 = Sisimai::Address.find(argvs['addresser'])
+      y0 = Sisimai::Address.find(argvs['recipient'])
 
       return nil unless x0.is_a? Array
       return nil unless y0.is_a? Array
 
-      thing[:addresser] = Sisimai::Address.new(x0.shift)
+      thing[:addresser] = Sisimai::Address.new(x0[0]['address'])
       return nil unless thing[:addresser].is_a? Sisimai::Address
       return nil if thing[:addresser].void
       thing[:senderdomain] = thing[:addresser].host
 
-      thing[:recipient] = Sisimai::Address.new(y0.shift)
+      thing[:recipient] = Sisimai::Address.new(y0[0]['address'])
       return nil unless thing[:recipient].is_a? Sisimai::Address
       return nil if thing[:recipient].void
       thing[:destination] = thing[:recipient].host

data/lib/sisimai/message.rb

@@ -1,8 +1,8 @@
 module Sisimai
-  # Sisimai::Message convert bounce email text to data structure. It resolve email
-  # text into an UNIX From line, the header part of the mail, delivery status, and
-  # RFC822 header part. When the email given as a argument of "new" method is not a
-  # bounce email, the method returns nil.
+  # Sisimai::Message convert bounce email text to data structure. It resolve
+  # email text into an UNIX From line, the header part of the mail, delivery
+  # status, and RFC822 header part. When the email given as a argument of "new"
+  # method is not a bounce email, the method returns nil.
   class Message
     # Imported from p5-Sisimail/lib/Sisimai/Message.pm
     require 'sisimai/arf'
@@ -15,7 +15,7 @@ module Sisimai
     @@rwaccessors = [
       :from,    # [String] UNIX From line
       :header,  # [Hash]   Header part of an email
-      :ds,      # [Array]  Parsed data by Sisimai::MTA::*
+      :ds,      # [Array]  Parsed data by Sisimai::Bite::*::* module
       :rfc822,  # [Hash]   Header part of the original message
       :catch,   # [?]      The results returned by hook method
     ]
@@ -76,7 +76,7 @@ module Sisimai
         'field' => field,
       }
       [:load, :order].each do |e|
-        # Order of MTA, MSP modules
+        # Order of MTA modules
         next unless argvs.key?(e)
         next unless argvs[e].is_a? Array
         next if argvs[e].empty?

data/lib/sisimai/message/email.rb

@@ -71,7 +71,7 @@ module Sisimai
         processing['from']   = aftersplit['from']
         processing['header'] = Sisimai::Message::Email.headers(aftersplit['header'], headerargv)
 
-        # 3. Check headers for detecting MTA/MSP module
+        # 3. Check headers for detecting MTA modules
         if headerargv['tryonfirst'].empty?
           headerargv['tryonfirst'].concat(Sisimai::Message::Email.makeorder(processing['header']))
         end
@@ -96,10 +96,10 @@ module Sisimai
         rfc822part = aftersplit['body'] if rfc822part.empty?
 
         if rfc822part.is_a? ::String
-          # The value returned from Sisimai::MTA::* or Sisimai::MSP::* modules
+          # The value returned from Sisimai::Bite::Email::* modules
           processing['rfc822'] = Sisimai::Message::Email.takeapart(rfc822part)
         else
-          # The value returned from Sisimai::CED::* modules
+          # The value returned from Sisimai::Bite::JSON::* modules
           processing['rfc822'] = rfc822part
         end
 
@@ -274,9 +274,9 @@ module Sisimai
         return structured
       end
 
-      # Check headers for detecting MTA/MSP module and returns the order of modules
+      # Check headers for detecting MTA module and returns the order of modules
       # @param         [Hash] heads   Email header data
-      # @return        [Array]        Order of MTA/MSP modules
+      # @return        [Array]        Order of MTA modules
       def self.makeorder(heads)
         return [] unless heads
         return [] unless heads['subject']
@@ -379,7 +379,7 @@ module Sisimai
         return takenapart
       end
 
-      # Parse bounce mail with each MTA/MSP module
+      # @abstract Parse bounce mail with each MTA module
       # @param               [Hash] argvs    Processing message entity.
       # @param options argvs [Hash] mail     Email message entity
       # @param options mail  [String] from   From line of mbox
@@ -387,7 +387,7 @@ module Sisimai
       # @param options mail  [String] rfc822 Original message part
       # @param options mail  [Array]  ds     Delivery status list(parsed data)
       # @param options argvs [String] body   Email message body
-      # @param options argvs [Array] tryonfirst  MTA/MSP module list to load on first
+      # @param options argvs [Array] tryonfirst  MTA module list to load on first
       # @param options argvs [Array] tobeloaded  User defined MTA module list
       # @return              [Hash]          Parsed and structured bounce mails
       def self.parse(argvs)
@@ -483,7 +483,7 @@ module Sisimai
             # 1. Sisimai::ARF
             # 2. User-Defined Module
             # 3. MTA Module Candidates to be tried on first
-            # 4. Sisimai::MTA::* and MSP::*
+            # 4. Sisimai::Bite::Email::*
             # 5. Sisimai::RFC3464
             # 6. Sisimai::RFC3834
             #
@@ -523,10 +523,11 @@ module Sisimai
             end
 
             DefaultSet.each do |r|
-              # MTA/MSP modules which does not have MTA specific header and did
+              # MTA modules which does not have MTA specific header and did
               # not match with any regular expressions of Subject header.
               next if haveloaded.key?(r)
               begin
+                require r.gsub('::', '/').downcase
                 scannedset = Module.const_get(r).scan(mailheader, bodystring)
                 haveloaded[r] = true
                 throw :SCANNER if scannedset
@@ -537,8 +538,8 @@ module Sisimai
 
             end
 
-            # When the all of Sisimai::MTA::* modules did not return bounce data,
-            # call Sisimai::RFC3464;
+            # When the all of Sisimai::Bite::Email::* modules did not return
+            # bounce data, call Sisimai::RFC3464;
             require 'sisimai/rfc3464'
             scannedset = Sisimai::RFC3464.scan(mailheader, bodystring)
             break if scannedset

data/lib/sisimai/message/json.rb

@@ -15,8 +15,8 @@ module Sisimai
       # Make data structure from decoded JSON object
       # @param         [Hash] argvs   Bounce object
       # @options argvs [Hash]   data  Decoded JSON
-      # @options argvs [Array]  load  User defined CED module list
-      # @options argvs [Array]  order The order of CED modules
+      # @options argvs [Array]  load  User defined MTA(JSON) module list
+      # @options argvs [Array]  order The order of MTA(JSON) modules
       # @options argvs [Code]   hook  Reference to callback method
       # @return        [Hash]         Resolved data structure
       def self.make(argvs)
@@ -48,10 +48,10 @@ module Sisimai
         return processing
       end
 
-      # Load CED  modules which specified at 'order' and 'load' in the argument
+      # Load MTA(JSON) modules which specified at 'order' and 'load' in the argument
       # @param         [Hash] argvs       Module information to be loaded
-      # @options argvs [Array]  load      User defined CED module list
-      # @options argvs [Array]  order     The order of CED modules
+      # @options argvs [Array]  load      User defined MTA(JSON) module list
+      # @options argvs [Array]  order     The order of MTA(JSON) modules
       # @return        [Array]            Module list
       # @since v4.20.0
       def self.load(argvs)
@@ -59,7 +59,7 @@ module Sisimai
         tobeloaded = []
 
         %w|load order|.each do |e|
-          # The order of CED modules specified by user
+          # The order of MTA(JSON) modules specified by user
           next unless argvs.key?(e)
           next unless argvs[e].is_a? Array
           next if argvs[e].empty?
@@ -67,9 +67,9 @@ module Sisimai
           modulelist.concat(argvs['order']) if e == 'order'
           next unless e == 'load'
 
-          # Load user defined CED module
+          # Load user defined MTA(JSON) module
           argvs['load'].each do |v|
-            # Load user defined CED module
+            # Load user defined MTA(JSON) module
             begin
               require v.to_s.gsub('::', '/').downcase
             rescue LoadError
@@ -81,7 +81,7 @@ module Sisimai
         end
 
         modulelist.each do |e|
-          # Append the custom order of CED modules
+          # Append the custom order of MTA(JSON) modules
           next if tobeloaded.index(e)
           tobeloaded << e
         end
@@ -89,10 +89,10 @@ module Sisimai
         return tobeloaded
       end
 
-      # Check the decoded JSON strucutre for detecting CED modules and returns
-      # the order of modules to be called.
+      # Check the decoded JSON strucutre for detecting MTA(JSON) modules and
+      # returns the order of modules to be called.
       # @param         [Hash] heads   Decoded JSON object
-      # @return        [Array]        Order of CED modules
+      # @return        [Array]        Order of MTA(JSON) modules
       def self.makeorder(argvs)
         return [] unless argvs
         return [] unless argvs.keys.size > 0
@@ -100,7 +100,7 @@ module Sisimai
 
         # Seek some key names from given argument
         ObjectKeys.each_key do |e|
-          # Get CED module list matched with a specified key
+          # Get MTA(JSON) module list matched with a specified key
           next unless argvs.key?(e)
 
           # Matched and push it into the order list
@@ -110,7 +110,7 @@ module Sisimai
         return order
       end
 
-      # Parse bounce object with each CED module
+      # Parse bounce object with each MTA(JSON) module
       # @param               [Hash] argvs    Processing message entity.
       # @param options argvs [Hash] json     Decoded bounce object
       # @param options argvs [Proc] hook     Hook method to be called
@@ -141,11 +141,11 @@ module Sisimai
         catch :ADAPTOR do
           loop do
             # 1. User-Defined Module
-            # 2. CED Module Candidates to be tried on first
-            # 3. Sisimai::CED::*
+            # 2. MTA(JSON) Module Candidates to be tried on first
+            # 3. Sisimai::Bite::JSON::*
             #
             @@ToBeLoaded.each do |r|
-              # Call user defined CED modules
+              # Call user defined MTA(JSON) modules
               next if haveloaded[r]
               begin
                 require r.gsub('::', '/').downcase
@@ -159,7 +159,8 @@ module Sisimai
             end
 
             @@TryOnFirst.each do |r|
-              # Try CED module candidates which are detected from object key names
+              # Try MTA(JSON) module candidates which are detected from object
+              # key names
               next if haveloaded.key?(r)
               begin
                 require r.gsub('::', '/').downcase
@@ -173,7 +174,7 @@ module Sisimai
             end
 
             DefaultSet.each do |r|
-              # Default order of CED modules
+              # Default order of MTA(JSON) modules
               next if haveloaded.key?(r)
               begin
                 require r.gsub('::', '/').downcase

data/lib/sisimai/msp.rb

@@ -6,13 +6,25 @@ module Sisimai
       require 'sisimai/skeleton'
       require 'sisimai/rfc5322'
 
-      def INDICATORS;        return Sisimai::Skeleton.INDICATORS;     end
-      def DELIVERYSTATUS;    return Sisimai::Skeleton.DELIVERYSTATUS; end
-      def smtpagent(v = ''); return v.to_s.sub(/\ASisimai::/, '');    end
+      def INDICATORS
+        warn ' ***warning: Sisimai::MSP->INDICATORS has been moved to Sisimai::Bite::Email->INDICATORS'
+        return Sisimai::Skeleton.INDICATORS
+      end
+
+      def DELIVERYSTATUS
+        warn ' ***warning: Sisimai::MSP->DELIVERYSTATUS has been moved to Sisimai::Bite->DELIVERYSTATUS'
+        return Sisimai::Skeleton.DELIVERYSTATUS
+      end
+
+      def smtpagent(v = '')
+        warn ' ***warning: Sisimai::MSP->smtpagent has been moved to Sisimai::Bite->smtpagent'
+        return v.to_s.sub(/\ASisimai::/, '')
+      end
 
       # MSP list
       # @return   [Array] MSP list with order
       def index
+        warn ' ***warning: Sisimai::MSP->index has been moved to Sisimai::Bite::Email->index'
         return [
           'US::Google', 'US::Yahoo', 'US::Aol', 'US::Outlook', 'US::AmazonSES',
           'US::SendGrid', 'US::GSuite', 'US::Verizon', 'RU::MailRu', 'RU::Yandex',

data/lib/sisimai/mta.rb

@@ -6,13 +6,25 @@ module Sisimai
       require 'sisimai/skeleton'
       require 'sisimai/rfc5322'
 
-      def INDICATORS;        return Sisimai::Skeleton.INDICATORS;     end
-      def DELIVERYSTATUS;    return Sisimai::Skeleton.DELIVERYSTATUS; end
-      def smtpagent(v = ''); return v.to_s.sub(/\ASisimai::/, '');    end
+      def INDICATORS
+        warn ' ***warning: Sisimai::MTA->INDICATORS has been moved to Sisimai::Bite::Email->INDICATORS'
+        return Sisimai::Skeleton.INDICATORS
+      end
+
+      def DELIVERYSTATUS
+        warn ' ***warning: Sisimai::MTA->DELIVERYSTATUS has been moved to Sisimai::Bite->DELIVERYSTATUS'
+        return Sisimai::Skeleton.DELIVERYSTATUS
+      end
+
+      def smtpagent(v = '')
+        warn ' ***warning: Sisimai::MTA->smtpagent has been moved to Sisimai::Bite->smtpagent'
+        return v.to_s.sub(/\ASisimai::/, '')
+      end
 
       # MTA list
       # @return   [Array] MTA list with order
       def index
+        warn ' ***warning: Sisimai::MTA->index has been moved to Sisimai::Bite::Email->index'
         return %w|
           Sendmail Postfix Qmail Exim Courier OpenSMTPD Exchange2007 Exchange2003
           MessagingServer Domino Notes ApacheJames McAfee MXLogic MailFoundry