sisimai 4.25.3-java → 4.25.4-java

data/lib/sisimai/{bite/email → lhost}/sendgrid.rb

@@ -1,19 +1,19 @@
-module Sisimai::Bite::Email
-  # Sisimai::Bite::Email::SendGrid parses a bounce email which created by
+module Sisimai::Lhost
+  # Sisimai::Lhost::SendGrid parses a bounce email which created by
   # SendGrid. Methods in the module are called from only Sisimai::Message.
   module SendGrid
     class << self
-      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/SendGrid.pm
-      require 'sisimai/bite/email'
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/SendGrid.pm
+      require 'sisimai/lhost'
 
-      Indicators = Sisimai::Bite::Email.INDICATORS
+      Indicators = Sisimai::Lhost.INDICATORS
       StartingOf = {
         message: ['This is an automatically generated message from SendGrid.'],
         rfc822:  ['Content-Type: message/rfc822'],
       }.freeze
 
-      def description; return 'SendGrid: http://sendgrid.com/'; end
-      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def description; return 'SendGrid: https://sendgrid.com/'; end
+      def smtpagent;   return Sisimai::Lhost.smtpagent(self); end
 
       # Return-Path: <apps@sendgrid.net>
       # X-Mailer: MIME-tools 5.502 (Entity 5.502)
@@ -30,7 +30,7 @@ module Sisimai::Bite::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)
+      def make(mhead, mbody)
         # :'from'        => %r/\AMAILER-DAEMON\z/,
         return nil unless mhead['return-path']
         return nil unless mhead['return-path'] == '<apps@sendgrid.net>'
@@ -40,7 +40,7 @@ module Sisimai::Bite::Email
         fieldtable = Sisimai::RFC1894.FIELDTABLE
         permessage = {}     # (Hash) Store values of each Per-Message field
 
-        dscontents = [Sisimai::Bite.DELIVERYSTATUS]
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
         hasdivided = mbody.split("\n")
         havepassed = ['']
         rfc822list = []     # (Array) Each line in message/rfc822 part string
@@ -95,7 +95,7 @@ module Sisimai::Bite::Email
                 # - Diagnostic-Code: 550 5.1.1 ... (No "diagnostic-type" sub field)
                 next unless cv = e.match(/\ADiagnostic-Code:[ ]*(.+)/)
                 v['diagnosis'] = cv[1]
-                next;
+                next
               end
 
               if o[-1] == 'addr'
@@ -105,7 +105,7 @@ module Sisimai::Bite::Email
                   # Final-Recipient: rfc822; kijitora@example.jp
                   if v['recipient']
                     # There are multiple recipient addresses in the message body.
-                    dscontents << Sisimai::Bite.DELIVERYSTATUS
+                    dscontents << Sisimai::Lhost.DELIVERYSTATUS
                     v = dscontents[-1]
                   end
                   v['recipient'] = o[2]
@@ -183,6 +183,115 @@ module Sisimai::Bite::Email
         return { 'ds' => dscontents, 'rfc822' => rfc822part }
       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
+      #                             nil if it failed to parse or the
+      #                             arguments are missing
+      # @since v4.20.0
+      # @until v4.25.5
+      def json(argvs)
+        return nil unless argvs.is_a? Hash
+        return nil if argvs.empty?
+        return nil unless argvs.key?('email')
+        return nil unless Sisimai::RFC5322.is_emailaddress(argvs['email'])
+
+        dscontents = nil
+        rfc822head = {}
+        v = nil
+
+        if argvs.key?('event')
+          # https://sendgrid.com/docs/API_Reference/Webhooks/event.html
+          # {
+          #   'tls' => 0,
+          #   'timestamp' => 1504555832,
+          #   'event' => 'bounce',
+          #   'email' => 'mailboxfull@example.jp',
+          #   'ip' => '192.0.2.22',
+          #   'sg_message_id' => '03_Wof6nRbqqzxRvLpZbfw.filter0017p3mdw1-11399-59ADB335-16.0',
+          #   'type' => 'blocked',
+          #   'sg_event_id' => 'S4wr46YHS0qr3BKhawTQjQ',
+          #   'reason' => '550 5.2.2 <mailboxfull@example.jp>... Mailbox Full ',
+          #   'smtp-id' => '<201709042010.v84KAQ5T032530@example.nyaan.jp>',
+          #   'status' => '5.2.2'
+          # },
+          return nil unless %w[bounce deferred delivered spamreport].include?(argvs['event'])
+          dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
+          diagnostic = argvs['reason']   || ''
+          diagnostic = argvs['response'] || '' if diagnostic.empty?
+          timestamp0 = Sisimai::Time.parse(::Time.at(argvs['timestamp']).to_s)
+          v = dscontents[-1]
+
+          v['date']      = timestamp0.strftime("%a, %d %b %Y %T %z")
+          v['agent']     = self.smtpagent
+          v['lhost']     = argvs['ip'] || ''
+          v['status']    = argvs['status'] || nil
+          v['diagnosis'] = Sisimai::String.sweep(diagnostic)
+          v['recipient'] = argvs['email']
+
+          if argvs['event'] == 'delivered'
+            # "event": "delivered"
+            v['reason'] = 'delivered'
+          elsif argvs['event'] == 'spamreport'
+            # [
+            #   {
+            #     "email": "kijitora@example.com",
+            #     "timestamp": 1504837383,
+            #     "sg_message_id": "6_hrAeKvTDaB5ynBI2nbnQ.filter0002p3las1-27574-59B1FDA3-19.0",
+            #     "sg_event_id": "o70uHqbMSXOaaoveMZIjjg",
+            #     "event": "spamreport"
+            #   }
+            # ]
+            v['reason'] = 'feedback'
+            v['feedbacktype'] = 'abuse'
+          end
+          v['status']    ||= Sisimai::SMTP::Status.find(v['diagnosis']) || ''
+          v['replycode'] ||= Sisimai::SMTP::Reply.find(v['diagnosis'])  || ''
+
+          # Generate pseudo message/rfc822 part
+          rfc822head = {
+            'from'       => Sisimai::Address.undisclosed('s'),
+            'message-id' => v['sg_message_id'],
+          }
+        else
+          #   {
+          #       "status": "4.0.0",
+          #       "created": "2011-09-16 22:02:19",
+          #       "reason": "Unable to resolve MX host sendgrid.ne",
+          #       "email": "esting@sendgrid.ne"
+          #   },
+          dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
+          v = dscontents[-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
+
+          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 = {
+            'from' => Sisimai::Address.undisclosed('s'),
+            'date' => v['date'],
+          }
+        end
+        return { 'ds' => dscontents, 'rfc822' => rfc822head }
+      end
+
     end
   end
 end

data/lib/sisimai/{bite/email → lhost}/sendmail.rb

@@ -1,12 +1,12 @@
-module Sisimai::Bite::Email
-  # Sisimai::Bite::Email::Sendmail parses a bounce email which created by
+module Sisimai::Lhost
+  # Sisimai::Lhost::Sendmail parses a bounce email which created by
   # v8 Sendmail. Methods in the module are called from only Sisimai::Message.
   module Sendmail
     class << self
-      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/Sendmail.pm
-      require 'sisimai/bite/email'
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/Sendmail.pm
+      require 'sisimai/lhost'
 
-      Indicators = Sisimai::Bite::Email.INDICATORS
+      Indicators = Sisimai::Lhost.INDICATORS
       StartingOf = {
         # Error text regular expressions which defined in sendmail/savemail.c
         #   savemail.c:1040|if (printheader && !putline("   ----- Transcript of session follows -----\n",
@@ -22,7 +22,7 @@ module Sisimai::Bite::Email
       }.freeze
 
       def description; return 'V8Sendmail: /usr/sbin/sendmail'; end
-      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def smtpagent;   return Sisimai::Lhost.smtpagent(self); end
       def headerlist;  return []; end
 
       # Parse bounce messages from Sendmail
@@ -36,7 +36,7 @@ module Sisimai::Bite::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)
+      def make(mhead, mbody)
         return nil unless mhead['subject'] =~ /(?:see transcript for details\z|\AWarning: )/
         unless mhead['subject'].downcase =~ /\A[ \t]*fwd?:/
           # Fwd: Returned mail: see transcript for details
@@ -48,7 +48,7 @@ module Sisimai::Bite::Email
         fieldtable = Sisimai::RFC1894.FIELDTABLE
         permessage = {}     # (Hash) Store values of each Per-Message field
 
-        dscontents = [Sisimai::Bite.DELIVERYSTATUS]
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
         hasdivided = mbody.split("\n")
         havepassed = ['']
         rfc822list = []     # (Array) Each line in message/rfc822 part string
@@ -107,7 +107,7 @@ module Sisimai::Bite::Email
                   # Final-Recipient: rfc822; kijitora@example.jp
                   if v['recipient']
                     # There are multiple recipient addresses in the message body.
-                    dscontents << Sisimai::Bite.DELIVERYSTATUS
+                    dscontents << Sisimai::Lhost.DELIVERYSTATUS
                     v = dscontents[-1]
                   end
                   v['recipient'] = o[2]

data/lib/sisimai/{bite/email → lhost}/surfcontrol.rb

@@ -1,20 +1,20 @@
-module Sisimai::Bite::Email
-  # Sisimai::Bite::Email::SurfControl parses a bounce email which created by
+module Sisimai::Lhost
+  # Sisimai::Lhost::SurfControl parses a bounce email which created by
   # WebSense SurfControl.
   # Methods in the module are called from only Sisimai::Message.
   module SurfControl
     class << self
-      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/SurfControl.pm
-      require 'sisimai/bite/email'
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/SurfControl.pm
+      require 'sisimai/lhost'
 
-      Indicators = Sisimai::Bite::Email.INDICATORS
+      Indicators = Sisimai::Lhost.INDICATORS
       StartingOf = {
         message: ['Your message could not be sent.'],
         rfc822:  ['Content-Type: message/rfc822'],
       }.freeze
 
       def description; return 'WebSense SurfControl'; end
-      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def smtpagent;   return Sisimai::Lhost.smtpagent(self); end
       # X-SEF-ZeroHour-RefID: fgs=000000000
       # X-SEF-Processed: 0_0_0_000__2010_04_29_23_34_45
       # X-Mailer: SurfControl E-mail Filter
@@ -31,7 +31,7 @@ module Sisimai::Bite::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)
+      def make(mhead, mbody)
         # :'from' => %r/ [(]Mail Delivery System[)]\z/,
         return nil unless mhead['x-sef-processed']
         return nil unless mhead['x-mailer']
@@ -39,7 +39,7 @@ module Sisimai::Bite::Email
 
         require 'sisimai/rfc1894'
         fieldtable = Sisimai::RFC1894.FIELDTABLE
-        dscontents = [Sisimai::Bite.DELIVERYSTATUS]
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
         hasdivided = mbody.split("\n")
         havepassed = ['']
         rfc822list = []     # (Array) Each line in message/rfc822 part string
@@ -97,7 +97,7 @@ module Sisimai::Bite::Email
               # Addressed To: kijitora@example.com
               if v['recipient']
                 # There are multiple recipient addresses in the message body.
-                dscontents << Sisimai::Bite.DELIVERYSTATUS
+                dscontents << Sisimai::Lhost.DELIVERYSTATUS
                 v = dscontents[-1]
               end
               v['recipient'] = cv[1]

data/lib/sisimai/{bite/email → lhost}/userdefined.rb

@@ -1,12 +1,12 @@
-module Sisimai::Bite::Email
-  # Sisimai::Bite::Email::UserDefined is an example module as a template to
+module Sisimai::Lhost
+  # Sisimai::Lhost::UserDefined is an example module as a template to
   # implement your custom MTA module.
   module UserDefined
     class << self
-      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/UserDefined.pm
-      require 'sisimai/bite/email'
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/UserDefined.pm
+      require 'sisimai/lhost'
 
-      Indicators = Sisimai::Bite::Email.INDICATORS
+      Indicators = Sisimai::Lhost.INDICATORS
       MarkingsOf = {
         # MarkingsOf is a delimiter set of these sections:
         #   message: The first line of a bounce message to be parsed.
@@ -20,7 +20,7 @@ module Sisimai::Bite::Email
       }.freeze
 
       def description; return 'Module description'; end
-      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def smtpagent;   return Sisimai::Lhost.smtpagent(self); end
       def headerlist;  return %w[x-some-userdefined-header]; end
 
       # @abstract Template for User-Defined MTA module
@@ -34,7 +34,7 @@ module Sisimai::Bite::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)
+      def make(mhead, mbody)
         # 1. Check some value in mhead using regular expression or "==" operator
         #    whether the bounce message should be parsed by this module or not.
         #   - Matched 1 or more values: Proceed to the step 2.
@@ -47,8 +47,8 @@ module Sisimai::Bite::Email
         return nil unless match > 0
 
         # 2. Parse message body(mbody) of the bounce message. See some modules
-        #    in lib/sisimai/bite/email directory to implement codes.
-        dscontents = [Sisimai::Bite.DELIVERYSTATUS]
+        #    in lib/sisimai/lhost directory to implement codes.
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
         hasdivided = mbody.split("\n")
         rfc822list = []     # (Array) Each line in message/rfc822 part string
         blanklines = 0      # (Integer) The number of blank lines

data/lib/sisimai/{bite/email → lhost}/v5sendmail.rb

@@ -1,14 +1,14 @@
-module Sisimai::Bite::Email
-  # Sisimai::Bite::Email::V5sendmail parses a bounce email which created by
+module Sisimai::Lhost
+  # Sisimai::Lhost::V5sendmail parses a bounce email which created by
   # Sendmail version 5.
   # Methods in the module are called from only Sisimai::Message.
   module V5sendmail
     class << self
-      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/V5sendmail.pm
-      require 'sisimai/bite/email'
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/V5sendmail.pm
+      require 'sisimai/lhost'
 
-      Indicators = Sisimai::Bite::Email.INDICATORS
-      StartingOf = { message: ['----- Transcript of session follows -----'] };
+      Indicators = Sisimai::Lhost.INDICATORS
+      StartingOf = { message: ['----- Transcript of session follows -----'] }
       MarkingsOf = {
         # Error text regular expressions which defined in src/savemail.c
         #   savemail.c:485| (void) fflush(stdout);
@@ -35,7 +35,7 @@ module Sisimai::Bite::Email
       }.freeze
 
       def description; return 'Sendmail version 5'; end
-      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def smtpagent;   return Sisimai::Lhost.smtpagent(self); end
       def headerlist;  return []; end
 
       # Parse bounce messages from Sendmail version 5
@@ -49,11 +49,11 @@ module Sisimai::Bite::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)
+      def make(mhead, mbody)
         # :from => %r/\AMail Delivery Subsystem/,
         return nil unless mhead['subject'] =~ /\AReturned mail: [A-Z]/
 
-        dscontents = [Sisimai::Bite.DELIVERYSTATUS]
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
         hasdivided = mbody.split("\n")
         rfc822list = []     # (Array) Each line in message/rfc822 part string
         blanklines = 0      # (Integer) The number of blank lines
@@ -107,7 +107,7 @@ module Sisimai::Bite::Email
               # 550 <kijitora@example.org>... User unknown
               if v['recipient']
                 # There are multiple recipient addresses in the message body.
-                dscontents << Sisimai::Bite.DELIVERYSTATUS
+                dscontents << Sisimai::Lhost.DELIVERYSTATUS
                 v = dscontents[-1]
               end
               v['recipient'] = cv[1]

data/lib/sisimai/{bite/email → lhost}/verizon.rb

@@ -1,15 +1,15 @@
-module Sisimai::Bite::Email
-  # Sisimai::Bite::Email::Verizon parses a bounce email which created by
+module Sisimai::Lhost
+  # Sisimai::Lhost::Verizon parses a bounce email which created by
   # Verizon Wireless.
   # Methods in the module are called from only Sisimai::Message.
   module Verizon
     class << self
-      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/Verizon.pm
-      require 'sisimai/bite/email'
-      Indicators = Sisimai::Bite::Email.INDICATORS
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/Verizon.pm
+      require 'sisimai/lhost'
+      Indicators = Sisimai::Lhost.INDICATORS
 
-      def description; return 'Verizon Wireless: http://www.verizonwireless.com'; end
-      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def description; return 'Verizon Wireless: https://www.verizonwireless.com'; end
+      def smtpagent;   return Sisimai::Lhost.smtpagent(self); end
       def headerlist;  return []; end
 
       # Parse bounce messages from Verizon
@@ -23,7 +23,7 @@ module Sisimai::Bite::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)
+      def make(mhead, mbody)
         match = -1
         while true
           # Check the value of "From" header
@@ -35,7 +35,7 @@ module Sisimai::Bite::Email
         end
         return nil if match < 0
 
-        dscontents = [Sisimai::Bite.DELIVERYSTATUS]
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
         hasdivided = mbody.split("\n")
         rfc822list = []     # (Array) Each line in message/rfc822 part string
         blanklines = 0      # (Integer) The number of blank lines
@@ -101,7 +101,7 @@ module Sisimai::Bite::Email
               if cv = e.match(/\A[ \t]+RCPT TO: (.*)\z/)
                 if v['recipient']
                   # There are multiple recipient addresses in the message body.
-                  dscontents << Sisimai::Bite.DELIVERYSTATUS
+                  dscontents << Sisimai::Lhost.DELIVERYSTATUS
                   v = dscontents[-1]
                 end
 
@@ -170,7 +170,7 @@ module Sisimai::Bite::Email
               if cv = e.match(/\ATo:[ \t]+(.*)\z/)
                 if v['recipient']
                   # There are multiple recipient addresses in the message body.
-                  dscontents << Sisimai::Bite.DELIVERYSTATUS
+                  dscontents << Sisimai::Lhost.DELIVERYSTATUS
                   v = dscontents[-1]
                 end
                 v['recipient'] = Sisimai::Address.s3s4(cv[1])

data/lib/sisimai/{bite/email → lhost}/x1.rb

@@ -1,19 +1,19 @@
-module Sisimai::Bite::Email
-  # Sisimai::Bite::Email::X1 parses a bounce email which created by Unknown
+module Sisimai::Lhost
+  # Sisimai::Lhost::X1 parses a bounce email which created by Unknown
   # MTA #1. Methods in the module are called from only Sisimai::Message.
   module X1
     class << self
-      # Imported from p5-Sisimail/lib/Sisimai/Bite/Email/X1.pm
-      require 'sisimai/bite/email'
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/X1.pm
+      require 'sisimai/lhost'
 
-      Indicators = Sisimai::Bite::Email.INDICATORS
+      Indicators = Sisimai::Lhost.INDICATORS
       MarkingsOf = {
         message: %r/\AThe original message was received at (.+)\z/,
         rfc822:  %r/\AReceived: from \d+[.]\d+[.]\d+[.]\d/,
       }.freeze
 
       def description; return 'Unknown MTA #1'; end
-      def smtpagent;   return Sisimai::Bite.smtpagent(self); end
+      def smtpagent;   return Sisimai::Lhost.smtpagent(self); end
       def headerlist;  return []; end
 
       # Parse bounce messages from Unknown MTA #1
@@ -27,11 +27,11 @@ module Sisimai::Bite::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)
+      def make(mhead, mbody)
         return nil unless mhead['subject'].start_with?('Returned Mail: ')
         return nil unless mhead['from'].start_with?('"Mail Deliver System" ')
 
-        dscontents = [Sisimai::Bite.DELIVERYSTATUS]
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
         hasdivided = mbody.split("\n")
         rfc822list = []     # (Array) Each line in message/rfc822 part string
         blanklines = 0      # (Integer) The number of blank lines
@@ -82,7 +82,7 @@ module Sisimai::Bite::Email
               # kijitora@example.co.jp [User unknown]
               if v['recipient']
                 # There are multiple recipient addresses in the message body.
-                dscontents << Sisimai::Bite.DELIVERYSTATUS
+                dscontents << Sisimai::Lhost.DELIVERYSTATUS
                 v = dscontents[-1]
               end
               v['recipient'] = cv[1]