sisimai 4.25.5 → 4.25.6

data/lib/sisimai/lhost/x3.rb

@@ -1,6 +1,6 @@
 module Sisimai::Lhost
-  # Sisimai::Lhost::X3 parses a bounce email which created by Unknown
-  # MTA #3. Methods in the module are called from only Sisimai::Message.
+  # Sisimai::Lhost::X3 parses a bounce email which created by Unknown MTA #3.
+  # Methods in the module are called from only Sisimai::Message.
   module X3
     class << self
       # Imported from p5-Sisimail/lib/Sisimai/Lhost/X3.pm
@@ -10,21 +10,11 @@ module Sisimai::Lhost
       ReBackbone = %r|^Content-Type:[ ]message/rfc822|.freeze
       StartingOf = { message: ['      This is an automatically generated Delivery Status Notification.'] }.freeze
 
-      def description; return 'Unknown MTA #3'; end
-      def smtpagent;   return Sisimai::Lhost.smtpagent(self); end
-      def headerlist;  return []; end
-
       # Parse bounce messages from Unknown MTA #3
-      # @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
+      # @param  [Hash] mhead    Message headers of a bounce email
+      # @param  [String] mbody  Message body of a bounce email
+      # @return [Hash]          Bounce data list and message/rfc822 part
+      # @return [Nil]           it failed to parse or the arguments are missing
       def make(mhead, mbody)
         return nil unless mhead['subject'].start_with?('Delivery status notification')
         return nil unless mhead['from'].start_with?('Mail Delivery System')
@@ -89,15 +79,13 @@ module Sisimai::Lhost
         return nil unless recipients > 0
 
         dscontents.each do |e|
-          e['agent']     = self.smtpagent
           e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
           e['status']    = Sisimai::SMTP::Status.find(e['diagnosis']) || ''
-          e.each_key { |a| e[a] ||= '' }
         end
 
         return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
       end
-
+      def description; return 'Unknown MTA #3'; end
     end
   end
 end

data/lib/sisimai/lhost/x4.rb

@@ -1,6 +1,6 @@
 module Sisimai::Lhost
-  # Sisimai::Lhost::X4 parses a bounce email which created by some qmail
-  # clone.  Methods in the module are called from only Sisimai::Message.
+  # Sisimai::Lhost::X4 parses a bounce email which created by some qmail clone.
+  # Methods in the module are called from only Sisimai::Message.
   module X4
     class << self
       # Imported from p5-Sisimail/lib/Sisimai/Lhost/X4.pm
@@ -117,21 +117,11 @@ module Sisimai::Lhost
         ],
       }.freeze
 
-      def description; return 'Unknown MTA #4'; end
-      def smtpagent;   return Sisimai::Lhost.smtpagent(self); end
-      def headerlist;  return []; end
-
       # Parse bounce messages from Unknown MTA #4
-      # @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
+      # @param  [Hash] mhead    Message headers of a bounce email
+      # @param  [String] mbody  Message body of a bounce email
+      # @return [Hash]          Bounce data list and message/rfc822 part
+      # @return [Nil]           it failed to parse or the arguments are missing
       def make(mhead, mbody)
         # Pre process email headers and the body part of the message which generated
         # by qmail, see https://cr.yp.to/qmail.html
@@ -192,7 +182,6 @@ module Sisimai::Lhost
         return nil unless recipients > 0
 
         dscontents.each do |e|
-          e['agent']     = self.smtpagent
           e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
 
           unless e['command']
@@ -254,12 +243,11 @@ module Sisimai::Lhost
               end
             end
           end
-          e.each_key { |a| e[a] ||= '' }
         end
 
         return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
       end
-
+      def description; return 'Unknown MTA #4'; end
     end
   end
 end

data/lib/sisimai/lhost/x5.rb

@@ -1,6 +1,6 @@
 module Sisimai::Lhost
-  # Sisimai::Lhost::X5 parses a bounce email which created by Unknown
-  # MTA #5. Methods in the module are called from only Sisimai::Message.
+  # Sisimai::Lhost::X5 parses a bounce email which created by Unknown MTA #5.
+  # Methods in the module are called from only Sisimai::Message.
   module X5
     class << self
       # Imported from p5-Sisimail/lib/Sisimai/Lhost/X5.pm
@@ -10,21 +10,11 @@ module Sisimai::Lhost
       ReBackbone = %r|^Content-Type:[ ]message/rfc822|.freeze
       StartingOf = { message: ['Content-Type: message/delivery-status'] }.freeze
 
-      def description; return 'Unknown MTA #5'; end
-      def smtpagent;   return Sisimai::Lhost.smtpagent(self); end
-      def headerlist;  return []; end
-
       # Parse bounce messages from Unknown MTA #5
-      # @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
+      # @param  [Hash] mhead    Message headers of a bounce email
+      # @param  [String] mbody  Message body of a bounce email
+      # @return [Hash]          Bounce data list and message/rfc822 part
+      # @return [Nil]           it failed to parse or the arguments are missing
       def make(mhead, mbody)
         match  = 0
         match += 1 if mhead['to'].to_s.include?('NotificationRecipients')
@@ -110,15 +100,10 @@ module Sisimai::Lhost
         end
         return nil unless recipients > 0
 
-        dscontents.each do |e|
-          e['agent']       = self.smtpagent
-          e['diagnosis'] ||= Sisimai::String.sweep(e['diagnosis'])
-          e.each_key { |a| e[a] ||= '' }
-        end
-
+        dscontents.each { |e| e['diagnosis'] ||= Sisimai::String.sweep(e['diagnosis']) }
         return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
       end
-
+      def description; return 'Unknown MTA #5'; end
     end
   end
 end

data/lib/sisimai/lhost/x6.rb

@@ -0,0 +1,74 @@
+module Sisimai::Lhost
+  # Sisimai::Lhost::X6 parses a bounce email which created by Unknown MTA #6.
+  # Methods in the module are called from only Sisimai::Message.
+  module X6
+    class << self
+      # Imported from p5-Sisimail/lib/Sisimai/Lhost/X6.pm
+      require 'sisimai/lhost'
+
+      Indicators = Sisimai::Lhost.INDICATORS
+      ReBackbone = %r/^The attachment contains the original mail headers.+$/.freeze
+      MarkingsOf = { message: %r/\A\d+[ ]*error[(]s[)]:/ }.freeze
+
+      # Parse bounce messages from Unknown MTA #6
+      # @param  [Hash] mhead    Message headers of a bounce email
+      # @param  [String] mbody  Message body of a bounce email
+      # @return [Hash]          Bounce data list and message/rfc822 part
+      # @return [Nil]           it failed to parse or the arguments are missing
+      # @since v4.25.6
+      def make(mhead, mbody)
+        return nil unless mhead['subject'].start_with?('There was an error sending your mail')
+
+        dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
+        emailsteak = Sisimai::RFC5322.fillet(mbody, ReBackbone)
+        bodyslices = emailsteak[0].split("\n")
+        readcursor = 0      # (Integer) Points the current cursor position
+        recipients = 0      # (Integer) The number of 'Final-Recipient' header
+        v = nil
+
+        while e = bodyslices.shift do
+          # Read error messages and delivery status lines from the head of the email
+          # to the previous line of the beginning of the original message.
+          if readcursor == 0
+            # Beginning of the bounce message or delivery status part
+            readcursor |= Indicators[:deliverystatus] if e =~ MarkingsOf[:message]
+            next
+          end
+          next if (readcursor & Indicators[:deliverystatus]) == 0
+          next if e.empty?
+
+          # 1 error(s):
+          #
+          # SMTP Server <mta2.example.jp> rejected recipient <kijitora@examplejp> 
+          #   (Error following RCPT command). It responded as follows: [550 5.1.1 User unknown]v = dscontents[-1]
+          v = dscontents[-1]
+          if cv = e.match(/<([^ @]+[@][^ @]+)>/) || e.match(/errors:[ ]*([^ ]+[@][^ ]+)/)
+            # SMTP Server <mta2.example.jp> rejected recipient <kijitora@examplejp> 
+            # The following recipients returned permanent errors: neko@example.jp.
+            if v['recipient']
+              # There are multiple recipient addresses in the message body.
+              dscontents << Sisimai::Lhost.DELIVERYSTATUS
+              v = dscontents[-1]
+            end
+            v['recipient'] = Sisimai::Address.s3s4(cv[1])
+            v['diagnosis'] = e
+            recipients += 1
+          end
+        end
+        return nil unless recipients > 0
+
+        dscontents.each do |e|
+          if cv = e['diagnosis'].match(/\b(HELO|EHLO|MAIL|RCPT|DATA)\b/)
+            # ...(Error following RCPT command).
+            e['command'] = cv[1]
+          end
+          e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'])
+        end
+
+        return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
+      end
+      def description; return 'Unknown MTA #6'; end
+    end
+  end
+end
+

data/lib/sisimai/lhost/yahoo.rb

@@ -1,6 +1,6 @@
 module Sisimai::Lhost
-  # Sisimai::Lhost::Yahoo parses a bounce email which created by Yahoo!
-  # MAIL. Methods in the module are called from only Sisimai::Message.
+  # Sisimai::Lhost::Yahoo parses a bounce email which created by Yahoo! MAIL.
+  # Methods in the module are called from only Sisimai::Message.
   module Yahoo
     class << self
       # Imported from p5-Sisimail/lib/Sisimai/Lhost/Yahoo.pm
@@ -10,28 +10,16 @@ module Sisimai::Lhost
       ReBackbone = %r|^--- Below this line is a copy of the message[.]|.freeze
       StartingOf = { message: ['Sorry, we were unable to deliver your message'] }.freeze
 
-      def description; return 'Yahoo! MAIL: https://www.yahoo.com'; end
-      def smtpagent;   return Sisimai::Lhost.smtpagent(self); end
-
-      # X-YMailISG: YtyUVyYWLDsbDh...
-      # X-YMail-JAS: Pb65aU4VM1mei...
-      # X-YMail-OSG: bTIbpDEVM1lHz...
-      # X-Originating-IP: [192.0.2.9]
-      def headerlist;  return %w[x-ymailisg]; end
-
       # Parse bounce messages from Yahoo! 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
+      # @param  [Hash] mhead    Message headers of a bounce email
+      # @param  [String] mbody  Message body of a bounce email
+      # @return [Hash]          Bounce data list and message/rfc822 part
+      # @return [Nil]           it failed to parse or the arguments are missing
       def make(mhead, mbody)
-        # :subject => %r/\AFailure Notice\z/,
+        # X-YMailISG: YtyUVyYWLDsbDh...
+        # X-YMail-JAS: Pb65aU4VM1mei...
+        # X-YMail-OSG: bTIbpDEVM1lHz...
+        # X-Originating-IP: [192.0.2.9]
         return nil unless mhead['x-ymailisg']
 
         dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
@@ -101,13 +89,12 @@ module Sisimai::Lhost
 
         dscontents.each do |e|
           e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'].gsub(/\\n/, ' '))
-          e['agent']     = self.smtpagent
           e['command'] ||= 'RCPT' if e['diagnosis'] =~ /[<].+[@].+[>]/
         end
 
         return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
       end
-
+      def description; return 'Yahoo! MAIL: https://www.yahoo.com'; end
     end
   end
 end

data/lib/sisimai/lhost/yandex.rb

@@ -1,6 +1,6 @@
 module Sisimai::Lhost
-  # Sisimai::Lhost::Yandex parses a bounce email which created by
-  # Yandex.Mail. Methods in the module are called from only Sisimai::Message.
+  # Sisimai::Lhost::Yandex parses a bounce email which created by Yandex.Mail.
+  # Methods in the module are called from only Sisimai::Message.
   module Yandex
     class << self
       # Imported from p5-Sisimail/lib/Sisimai/Lhost/Yandex.pm
@@ -10,30 +10,19 @@ module Sisimai::Lhost
       ReBackbone = %r|^Content-Type:[ ]message/rfc822|.freeze
       StartingOf = { message: ['This is the mail system at host yandex.ru.'] }.freeze
 
-      def description; return 'Yandex.Mail: https://www.yandex.ru'; end
-      def smtpagent;   return Sisimai::Lhost.smtpagent(self); end
-
-      # X-Yandex-Front: mxback1h.mail.yandex.net
-      # X-Yandex-TimeMark: 1417885948
-      # X-Yandex-Uniq: 92309766-f1c8-4bd4-92bc-657c75766587
-      # X-Yandex-Spam: 1
-      # X-Yandex-Forward: 10104c00ad0726da5f37374723b1e0c8
-      # X-Yandex-Queue-ID: 367D79E130D
-      # X-Yandex-Sender: rfc822; shironeko@yandex.example.com
-      def headerlist;  return %w[x-yandex-uniq]; end
-
       # Parse bounce messages from Yandex.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
+      # @param  [Hash] mhead    Message headers of a bounce email
+      # @param  [String] mbody  Message body of a bounce email
+      # @return [Hash]          Bounce data list and message/rfc822 part
+      # @return [Nil]           it failed to parse or the arguments are missing
       def make(mhead, mbody)
+        # X-Yandex-Front: mxback1h.mail.yandex.net
+        # X-Yandex-TimeMark: 1417885948
+        # X-Yandex-Uniq: 92309766-f1c8-4bd4-92bc-657c75766587
+        # X-Yandex-Spam: 1
+        # X-Yandex-Forward: 10104c00ad0726da5f37374723b1e0c8
+        # X-Yandex-Queue-ID: 367D79E130D
+        # X-Yandex-Sender: rfc822; shironeko@yandex.example.com
         return nil unless mhead['x-yandex-uniq']
         return nil unless mhead['from'] == 'mailer-daemon@yandex.ru'
 
@@ -123,12 +112,11 @@ module Sisimai::Lhost
 
           e['command']   = commandset.shift || ''
           e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'].tr("\n", ' '))
-          e['agent']     = self.smtpagent
         end
 
         return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
       end
-
+      def description; return 'Yandex.Mail: https://www.yandex.ru'; end
     end
   end
 end

data/lib/sisimai/lhost/zoho.rb

@@ -11,33 +11,15 @@ module Sisimai::Lhost
       StartingOf = { message: ['This message was created automatically by mail delivery'] }.freeze
       MessagesOf = { 'expired' => ['Host not reachable'] }.freeze
 
-      def description; return 'Zoho Mail: https://www.zoho.com'; end
-      def smtpagent;   return Sisimai::Lhost.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 %w[x-zohomail]; 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
+      # @param  [Hash] mhead    Message headers of a bounce email
+      # @param  [String] mbody  Message body of a bounce email
+      # @return [Hash]          Bounce data list and message/rfc822 part
+      # @return [Nil]           it failed to parse or the arguments are missing
       def make(mhead, mbody)
-        # :'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/,
+        # 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
         return nil unless mhead['x-zohomail']
 
         dscontents = [Sisimai::Lhost.DELIVERYSTATUS]
@@ -109,9 +91,7 @@ module Sisimai::Lhost
         return nil unless recipients > 0
 
         dscontents.each do |e|
-          e['agent']     = self.smtpagent
           e['diagnosis'] = Sisimai::String.sweep(e['diagnosis'].tr("\n", ' '))
-
           MessagesOf.each_key do |r|
             # Verify each regular expression of session errors
             next unless MessagesOf[r].any? { |a| e['diagnosis'].include?(a) }
@@ -122,7 +102,7 @@ module Sisimai::Lhost
 
         return { 'ds' => dscontents, 'rfc822' => emailsteak[1] }
       end
-
+      def description; return 'Zoho Mail: https://www.zoho.com'; end
     end
   end
 end

data/lib/sisimai/mail.rb

@@ -1,27 +1,30 @@
 module Sisimai
-  # Sisimai::Mail is a handler of UNIX mbox or Maildir for reading each mail. It is
-  # wrapper class of Sisimai::Mail::Mbox and Sisimai::Mail::Maildir classes.
+  # Sisimai::Mail is a handler of UNIX mbox or Maildir for reading each mail.
+  # It is a wrapper class of Sisimai::Mail::Mbox, Sisimai::Mail::Maildir, and
+  # Sisimai::Mail::Memory classes.
   class Mail
     # Imported from p5-Sisimail/lib/Sisimai/Mail.pm
+    Until = 'v4.25.10'
+
     # :path [String] path to mbox or Maildir/
-    # :type [String] Data type: mailbox, maildir, or stdin
-    # :mail [Sisimai::Mail::[Mbox,Maildir,Memory,STDIN]] Object
-    attr_reader   :path, :type
-    attr_accessor :mail
+    # :kind [String] Data type: mailbox, maildir, or stdin
+    # :data [Sisimai::Mail::[Mbox,Maildir,Memory,STDIN]] Object
+    attr_reader   :path, :kind
+    attr_accessor :data
 
     # Constructor of Sisimai::Mail
     # @param    [String] argv1        Path to mbox or Maildir/
     # @return   [Sisimai::Mail, Nil]  Object or nil if the argument was wrong
     def initialize(argv1)
       classname = nil
-      parameter = { 'path' => argv1, 'type' => nil, 'mail' => nil }
+      parameter = { 'path' => argv1, 'kind' => nil, 'data' => nil }
 
       if argv1.is_a?(::String)
         # Path to mail or '<STDIN>' ?
         if argv1 == '<STDIN>'
           # Sisimai::Mail.new('<STDIN>')
           classname = self.class.to_s << '::STDIN'
-          parameter['type'] = 'stdin'
+          parameter['kind'] = 'stdin'
           parameter['path'] = $stdin
         else
           # The argumenet is a mailbox or a Maildir/.
@@ -30,17 +33,17 @@ module Sisimai
           if mediatype == 'file'
             # The argument is a file, it is an mbox or email file in Maildir/
             classname = self.class.to_s << '::Mbox'
-            parameter['type'] = 'mailbox'
+            parameter['kind'] = 'mailbox'
 
           elsif mediatype == 'directory'
             # The agument is not a file, it is a Maildir/
             classname = self.class.to_s << '::Maildir'
-            parameter['type'] = 'maildir'
+            parameter['kind'] = 'maildir'
 
           elsif mediatype == 'memory'
             # The argument is an email string
             classname = self.class.to_s << '::Memory'
-            parameter['type'] = 'memory'
+            parameter['kind'] = 'memory'
             parameter['path'] = 'MEMORY'
           end
         end
@@ -48,33 +51,45 @@ module Sisimai
         # Read from STDIN
         # The argument neither a mailbox nor a Maildir/.
         classname = self.class.to_s << '::STDIN'
-        parameter['type'] = 'stdin'
+        parameter['kind'] = 'stdin'
       end
       return nil unless classname
 
       classpath = classname.gsub('::', '/').downcase
       require classpath
-      parameter['mail'] = Module.const_get(classname).new(argv1)
+      parameter['data'] = Module.const_get(classname).new(argv1)
 
       @path = parameter['path']
-      @type = parameter['type']
-      @mail = parameter['mail']
+      @kind = parameter['kind']
+      @data = parameter['data']
+    end
+
+    def mail
+      warn " ***warning: Sisimai::Mail.mail will be removed at #{Until}. Use Sisimai::Mail.data instead"
+      return data
     end
 
-    # Mbox/Maildir reader, works as an iterator.
+    def type
+      warn " ***warning: Sisimai::Mail.type will be removed at #{Until}. Use Sisimai::Mail.kind instead"
+      return kind
+    end
+
+    # Alias method of Sisimai::Mail.data.read()
     # @return   [String] Contents of mbox/Maildir
     def read
-      return nil unless mail
-      return mail.read
+      return nil unless data
+      return data.read
     end
 
     # Close the handle
     # @return   [True,False]  true:  Successfully closed the handle
     #                         false: Mail handle is not defined
     def close
-      return false unless mail.handle
-      mail.handle = nil
+      warn " ***warning: Sisimai::Mail.close will be removed at #{Until}. The handle automatically closes at the EOF"
+      return false unless data.handle
+      data.handle = nil
       return true
     end
   end
 end
+