sisimai 4.25.17 → 5.0.0

data/lib/sisimai/rhost/mimecast.rb

@@ -1,28 +1,35 @@
 module Sisimai
   module Rhost
-    # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Data object as an argu-
+    # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argu-
     # ment of get() method when the value of "rhost" of the object is "*.mimecast.com". This class
     # is called only Sisimai::Fact class.
     module Mimecast
       class << self
         MessagesOf = {
           # https://community.mimecast.com/s/article/Mimecast-SMTP-Error-Codes-842605754
-          'blocked' => [
-            # - The sender's IP address has been blocked by a Blocked Senders Policy.
-            # - Remove the entry from the policy.
-            [421, 'sender address blocked'],
-
-            # - The Sender's IP address has been placed on the block list due to too many invalid
-            #   connections.
-            # - The sender's mail server must retry the connection. The mail server performing the
-            #   connection says the recipient address validation isn't responding.
-            [451, 'recipient temporarily unavailable'],
+          'authfailure' => [
+            # - The inbound message has been rejected because the originated IP address isn't list-
+            #   ed in the published SPF records for the sending domain.
+            # - Ensure all the IP addresses for your mail servers are listed in your SPF records.
+            #   Alternatively, create a DNS Authentication (Inbound / Outbound) policy with the
+            #   "Inbound SPF" or "Reject on Hard Fail" option disabled. Messages that fail our SPF
+            #   checks are subjected to spam and RBL checks, instead of being rejected.
+            [550, 'spf sender invalid - envelope rejected'],
 
-            # - You've reached your mail server's limit.
-            # - Wait and try again. The mail server won't accept any messages until you're under
-            #   the limit.
-            [451, 'ip temporarily blacklisted'],
+            # - The DKIM key for the outbound message is broken and doesn't match the DNS record of
+            #   the registered sender.
+            # - Check your organization's DNS record is populated with the right public key as part
+            #   of the DNS Authentication Outbound Signing definition. The private key of the key-
+            #   pair must be populated in the DNS Authentication policy, along with the domain and
+            #   selector of that record.
+            [550, 'dkim sender invalid - envelope rejected'],
 
+            # - The inbound message has been rejected because the originated IP address isn't list-
+            #   ed in the published SPF records for the sending domain.
+            # - Ensure all the IP addresses for your mail servers are listed in your SPF records.
+            [550, 'dmarc sender invalid - envelope rejected'],
+          ],
+          'badreputation' => [
             # - The sending mail server is subjected to Greylisting. This requires the server to
             #   retry the connection, between one minute and 12 hours. Alternatively, the sender's
             #   IP address has a poor reputation.
@@ -36,33 +43,28 @@ module Sisimai
             #   Note:
             #     You can request a review of your source IP ranges by completing our online form.
             [550, 'local ct ip reputation - (reject)'],
+          ],
+          'blocked' => [
+            # - The sender's IP address has been blocked by a Blocked Senders Policy.
+            # - Remove the entry from the policy.
+            [421, 'sender address blocked'],
+
+            # - The Sender's IP address has been placed on the block list due to too many invalid
+            #   connections.
+            # - The sender's mail server must retry the connection. The mail server performing the
+            #   connection says the recipient address validation isn't responding.
+            [451, 'recipient temporarily unavailable'],
+
+            # - You've reached your mail server's limit.
+            # - Wait and try again. The mail server won't accept any messages until you're under
+            #   the limit.
+            [451, 'ip temporarily blacklisted'],
 
             # - The sender's IP address is listed in an RBL. The text displayed is specific to the
             #   RBL which lists the sender's IP address.
             # - Bypass the RBL with an Auto Allow or Permitted Senders policy. Additionally request
             #   the associated IP address from the RBL.
             #[550, '< details of RBL >'], NEED AN ACTUAL ERROR MESSAGE STRING
-
-            # - The inbound message has been rejected because the originated IP address isn't list-
-            #   ed in the published SPF records for the sending domain.
-            # - Ensure all the IP addresses for your mail servers are listed in your SPF records.
-            #   Alternatively, create a DNS Authentication (Inbound / Outbound) policy with the
-            #   "Inbound SPF" or "Reject on Hard Fail" option disabled. Messages that fail our SPF
-            #   checks are subjected to spam and RBL checks, instead of being rejected.
-            [550, 'spf sender invalid - envelope rejected'],
-
-            # - The DKIM key for the outbound message is broken and doesn't match the DNS record of
-            #   the registered sender.
-            # - Check your organization's DNS record is populated with the right public key as part
-            #   of the DNS Authentication Outbound Signing definition. The private key of the key-
-            #   pair must be populated in the DNS Authentication policy, along with the domain and
-            #   selector of that record.
-            [550, 'dkim sender invalid - envelope rejected'],
-
-            # - The inbound message has been rejected because the originated IP address isn't list-
-            #   ed in the published SPF records for the sending domain.
-            # - Ensure all the IP addresses for your mail servers are listed in your SPF records.
-            [550, 'dmarc sender invalid - envelope rejected'],
           ],
           'mesgtoobig' => [
             # - The email size either exceeds an Email Size Limit policy or is larger than the
@@ -261,11 +263,11 @@ module Sisimai
         # @param    [Sisimai::Fact] argvs   Parsed email object
         # @return   [String]                The bounce reason for mimecast.com
         def get(argvs)
-          return '' unless argvs.replycode =~ /\A[245]\d\d\z/
-          return '' unless argvs.diagnosticcode
+          return '' unless Sisimai::SMTP::Reply.test(argvs['replycode'])
+          return '' unless argvs['diagnosticcode']
 
-          esmtperror = argvs.diagnosticcode.downcase || ''
-          esmtpreply = argvs.replycode.to_i
+          esmtperror = argvs['diagnosticcode'].downcase || ''
+          esmtpreply = argvs['replycode'].to_i
           reasontext = ''
 
           MessagesOf.each_key do |e|

data/lib/sisimai/rhost/nttdocomo.rb

@@ -1,24 +1,23 @@
 module Sisimai
   module Rhost
-    # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Data object as an argument
+    # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument
     # of get() method when the value of "rhost" of the object is "mfsmax.docomo.ne.jp". This class
-    # is called only Sisimai::Data class.
+    # is called only Sisimai::Fact class.
     module NTTDOCOMO
       class << self
         MessagesOf = {
-          'mailboxfull' => %r/552 too much mail data/,
-          'syntaxerror' => %r/(?:503 bad sequence of commands|504 command parameter not implemented)/,
-          'toomanyconn' => %r/552 too many recipients/,
-          'userunknown' => %r/550 unknown user/,
+          'mailboxfull' => ['552 too much mail data'],
+          'toomanyconn' => ['552 too many recipients'],
+          'syntaxerror' => ['503 bad sequence of commands', '504 command parameter not implemented'],
         }.freeze
 
         # Detect bounce reason from NTT DOCOMO
-        # @param    [Sisimai::Data] argvs   Parsed email object
+        # @param    [Sisimai::Fact] argvs   Parsed email object
         # @return   [String]                The bounce reason for docomo.ne.jp
         def get(argvs)
-          statuscode = argvs.deliverystatus          || ''
-          commandtxt = argvs.smtpcommand             || ''
-          esmtperror = argvs.diagnosticcode.downcase || ''
+          statuscode = argvs['deliverystatus']          || ''
+          thecommand = argvs['smtpcommand']             || ''
+          esmtperror = argvs['diagnosticcode'].downcase || ''
           reasontext = ''
 
           # Check the value of Status: field, an SMTP Reply Code, and the SMTP Command
@@ -51,12 +50,8 @@ module Sisimai
           else
             # The value of "Diagnostic-Code:" field is not empty
             MessagesOf.each_key do |e|
-              # - The key name is a bounce reason name
-              # - https://github.com/sisimai/go-sisimai/issues/64
-              # - After March 12, 2025, if an error message contains "550 Unknown user", the bounce
-              #   reason will be definitively "userunknown". This is because NTT DOCOMO no longer
-              #   rejects emails via SMTP for domain-specific rejection or specified reception filters.
-              next unless esmtperror =~ MessagesOf[e]
+              # Try to match the error message with message patterns defined in "MessagesOf"
+              next unless MessagesOf[e].any? { |a| esmtperror.include?(a) }
               reasontext = e
               break
             end
@@ -66,7 +61,7 @@ module Sisimai
             # A bounce reason did not decide from a status code, an error message.
             if statuscode == '5.0.0'
               # Status: 5.0.0
-              if commandtxt == 'RCPT'
+              if thecommand == 'RCPT'
                 # Your message to the following recipients cannot be delivered:
                 #
                 # <***@docomo.ne.jp>:
@@ -82,7 +77,7 @@ module Sisimai
                 # Diagnostic-Code: smtp; 550 Unknown user ***@docomo.ne.jp
                 reasontext = 'userunknown'
 
-              elsif commandtxt == 'DATA'
+              elsif thecommand == 'DATA'
                 # <***@docomo.ne.jp>: host mfsmax.docomo.ne.jp[203.138.181.240] said:
                 # 550 Unknown user ***@docomo.ne.jp (in reply to end of DATA
                 # command)

data/lib/sisimai/rhost/spectrum.rb

@@ -1,21 +1,19 @@
 module Sisimai
   module Rhost
-    # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Data
-    # object as an argument of get() method when the value of "destination" of
-    # the object is "charter.net". This class is called only Sisimai::Data class.
+    # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument
+    # of get() method when the value of "destination" of the object is "charter.net".  This class is
+    # called only Sisimai::Fact class.
     module Spectrum
       class << self
-        # Imported from p5-Sisimail/lib/Sisimai/Rhost/Spectrum.pm
         ErrorCodes = {
           # https://www.spectrumbusiness.net/support/internet/understanding-email-error-codes
           #   Error codes are placed in one of two categories: incoming or outgoing.
-          #   1. If you’re trying to send an email to a Charter email address from
-          #      a non-Charter email address (such as Gmail, Yahoo, Hotmail, etc.),
-          #      you may receive an error that begins with AUP#I, followed by four numbers.
+          #   1. If you are trying to send an email to a Charter email address from a non-Charter email
+          #      address (such as Gmail, Yahoo, Hotmail, etc.), you may receive an error that begins
+          #      with AUP#I, followed by four numbers.
           #
-          #   2. If you are trying to send an email from a Charter email address
-          #      to an outgoing recipient, you may get an error code beginning with
-          #      AUP#O, also followed by four numbers.
+          #   2. If you are trying to send an email from a Charter email address to an outgoing recipient,
+          #      you may get an error code beginning with AUP#O, also followed by four numbers.
           #
           1000 => 'blocked',         # Your IP address has been blocked due to suspicious activity. 
           1010 => 'rejected',        # This email account has been blocked from sending emails due to suspicious activity.
@@ -39,11 +37,11 @@ module Sisimai
         ].freeze
 
         # Detect bounce reason from https://www.spectrum.com/
-        # @param    [Sisimai::Data] argvs   Parsed email object
+        # @param    [Sisimai::Fact] argvs   Parsed email object
         # @return   [String, Nil]           The bounce reason at Spectrum
         # @since v4.25.8
         def get(argvs)
-          statusmesg = argvs.diagnosticcode
+          statusmesg = argvs['diagnosticcode']
           codenumber = 0
 
           if cv = statusmesg.match(/AUP#[-A-Za-z]*(\d{4})/)

data/lib/sisimai/rhost/{tencentqq.rb → tencent.rb}

@@ -1,11 +1,10 @@
 module Sisimai
   module Rhost
-    # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Data
-    # object as an argument of get() method when the value of "rhost" of the object
-    # is "mx*.qq.com". This class is called only Sisimai::Data class.
-    module TencentQQ
+    # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument
+    # of get() method when the value of "rhost" of the object is "mx*.qq.com". This class is called
+    # only Sisimai::Fact class.
+    module Tencent
       class << self
-        # Imported from p5-Sisimail/lib/Sisimai/Rhost/TencentQQ.pm
         MessagesOf = {
           # https://service.mail.qq.com/cgi-bin/help?id=20022
           'dmarc check failed'                    => 'blocked',
@@ -27,12 +26,12 @@ module Sisimai
         }.freeze
 
         # Detect bounce reason from Tencent QQ
-        # @param    [Sisimai::Data] argvs   Parsed email object
+        # @param    [Sisimai::Fact] argvs   Parsed email object
         # @return   [String]                The bounce reason at Tencent QQ
         def get(argvs)
-          return argvs.reason unless argvs.reason.empty?
+          return argvs['reason'] unless argvs['reason'].empty?
 
-          statusmesg = argvs.diagnosticcode.downcase
+          statusmesg = argvs['diagnosticcode'].downcase
           reasontext = ''
 
           MessagesOf.each_key do |e|

data/lib/sisimai/rhost.rb

@@ -1,29 +1,21 @@
 module Sisimai
-  # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Data
-  # object as an argument of get() method when the value of rhost of the object
-  # is listed in the results of Sisimai::Rhost->list method.
-  # This class is called only Sisimai::Data class.
+  # Sisimai::Rhost detects the bounce reason from the content of Sisimai::Fact object as an argument
+  # of get() method when the value of rhost of the object is listed in the results of Sisimai::Rhost
+  # ->list method. This class is called only Sisimai::Fact class.
   module Rhost
     class << self
-      # Imported from p5-Sisimail/lib/Sisimai/Rhost.pm
       RhostClass = {
-        'cox.net'                     => 'Cox',
-        '.prod.outlook.com'           => 'ExchangeOnline',
-        '.protection.outlook.com'     => 'ExchangeOnline',
-        'laposte.net'                 => 'FrancePTT',
-        'orange.fr'                   => 'FrancePTT',
-        'wanadoo.fr'                  => 'FrancePTT',
-        'smtp.secureserver.net'       => 'GoDaddy',
-        'mailstore1.secureserver.net' => 'GoDaddy',
-        'aspmx.l.google.com'          => 'GoogleApps',
-        'gmail-smtp-in.l.google.com'  => 'GoogleApps',
-        '.email.ua'                   => 'IUA',
-        'lsean.ezweb.ne.jp'           => 'KDDI',
-        'msmx.au.com'                 => 'KDDI',
-        '.mimecast.com'               => 'Mimecast',
-        'mfsmax.docomo.ne.jp'         => 'NTTDOCOMO',
-        'charter.net'                 => 'Spectrum',
-        '.qq.com'                     => 'TencentQQ',
+          'Cox'       => ['cox.net'],
+          'FrancePTT' => ['.laposte.net', '.orange.fr', '.wanadoo.fr'],
+          'GoDaddy'   => ['smtp.secureserver.net', 'mailstore1.secureserver.net'],
+          'Google'    => ['aspmx.l.google.com', 'gmail-smtp-in.l.google.com'],
+          'IUA'       => ['.email.ua'],
+          'KDDI'      => ['.ezweb.ne.jp', 'msmx.au.com'],
+          'Microsoft' => ['.prod.outlook.com', '.protection.outlook.com'],
+          'Mimecast'  => ['.mimecast.com'],
+          'NTTDOCOMO' => ['mfsmax.docomo.ne.jp'],
+          'Spectrum'  => ['charter.net'],
+          'Tencent'   => ['.qq.com'],
       }.freeze
 
       # The value of "rhost" is listed in RhostClass or not
@@ -35,10 +27,9 @@ module Sisimai
 
         host0 = rhost.downcase
         match = false
-
         RhostClass.each_key do |e|
           # Try to match with each key of RhostClass
-          next unless host0.end_with?(e)
+          next unless RhostClass[e].any? { |a| host0.end_with?(a) }
           match = true
           break
         end
@@ -46,19 +37,19 @@ module Sisimai
       end
 
       # Detect the bounce reason from certain remote hosts
-      # @param    [Sisimai::Data] argvs   Parsed email object
-      # @param    [String]        proxy   The alternative of the "rhost"
-      # @return   [String]                The value of bounce reason
+      # @param    [Hash]   argvs  Parsed email data
+      # @param    [String] proxy  The alternative of the "rhost"
+      # @return   [String]        The value of bounce reason
       def get(argvs, proxy = nil)
-        remotehost = proxy || argvs.rhost.downcase
+        remotehost = proxy || argvs['rhost'].downcase
         rhostclass = ''
         modulename = ''
 
         RhostClass.each_key do |e|
           # Try to match with each key of RhostClass
-          next unless remotehost.end_with?(e)
-          modulename = 'Sisimai::Rhost::' << RhostClass[e]
-          rhostclass = modulename.gsub('::', '/').downcase
+          next unless RhostClass[e].any? { |a| remotehost.end_with?(a) }
+          modulename = 'Sisimai::Rhost::' << e
+          rhostclass = 'sisimai/rhost/' << e.downcase
           break
         end
         return nil if rhostclass.empty?
@@ -70,3 +61,4 @@ module Sisimai
     end
   end
 end
+

data/lib/sisimai/smtp/command.rb

@@ -0,0 +1,59 @@
+module Sisimai
+  module SMTP
+    # Sisimai::SMTP::Transcript is an SMTP Command related utilities
+    module Command
+      class << self
+        Detectable = [
+          'HELO', 'EHLO', 'STARTTLS', 'AUTH PLAIN', 'AUTH LOGIN', 'AUTH CRAM-', 'AUTH DIGEST-',
+          'MAIL F', 'RCPT', 'RCPT T', 'DATA', 'QUIT', 'XFORWARD',
+        ].freeze
+
+        # Check that an SMTP command in the argument is valid or not
+        # @param    [String] argv0  An SMTP command
+        # @return   [Boolean]       0: Is not a valid SMTP command, 1: Is a valid SMTP command
+        # @since v5.0.0
+        def test(argv0 = '')
+          return nil  if argv0.empty?
+          return nil  if argv0.size < 4
+
+          comm0 = %w[HELO EHLO MAIL RCPT DATA QUIT RSET NOOP VRFY ETRN EXPN HELP]
+          comm1 = %w[AUTH STARTTLS XFORWARD]
+          return true if comm0.any? { |a| argv0.include?(a) }
+          return true if comm1.any? { |a| argv0.include?(a) }
+          return true if argv0.include?('CONN') # CONN is a pseudo SMTP command used only in Sisimai
+          return false
+        end
+
+        # Pick an SMTP command from the given string
+        # @param    [String] argv0  A transcript text MTA returned
+        # @return   [String]        An SMTP command
+        # @return   [undef]         Failed to find an SMTP command or the 1st argument is missing
+        # @since v5.0.0
+        def find(argv0 = '')
+          return nil unless Sisimai::SMTP::Command.test(argv0)
+
+          stringsize = argv0.size
+          commandmap = { 'STAR' => 'STARTTLS', 'XFOR' => 'XFORWARD' }
+          commandset = []
+          previouspp = 0
+
+          Detectable.each do |e|
+            # Find an SMTP command from the given string
+            p0 = argv0.index(e, previouspp)
+            next unless p0
+            next if p0 + 4 > stringsize
+            previouspp = p0
+
+            cv = argv0[p0, 4]; next if commandset.include?(cv)
+            cv = commandmap[cv] if commandmap.has_key?(cv)
+            commandset << cv
+          end
+
+          return nil if commandset.empty?
+          return commandset.pop
+        end
+      end
+    end
+  end
+end
+

data/lib/sisimai/smtp/error.rb

@@ -1,19 +1,16 @@
 module Sisimai
   module SMTP
-    # Sisimai::SMTP::Error is utilities for checking SMTP Errors from error
-    # message text.
+    # Sisimai::SMTP::Error is utilities for checking SMTP Errors from error message text.
     module Error
-      # Imported from p5-Sisimail/lib/Sisimai/SMTP/Error.pm
       class << self
         require 'sisimai/smtp/reply'
         require 'sisimai/smtp/status'
 
         SoftOrHard = {
           'soft' => %w[
-            blocked contenterror exceedlimit expired filtered mailboxfull
-            mailererror mesgtoobig networkerror norelaying policyviolation
-            rejected securityerror spamdetected suspend syntaxerror systemerror
-            systemfull toomanyconn virusdetected],
+            blocked contenterror exceedlimit expired filtered mailboxfull mailererror mesgtoobig
+            networkerror norelaying policyviolation rejected securityerror spamdetected suspend
+            syntaxerror systemerror systemfull toomanyconn virusdetected],
           'hard' => %w[hasmoved hostunknown userunknown]
         }.freeze