sisimai 5.3.0 → 5.4.0

data/lib/sisimai/smtp/status.rb

@@ -677,11 +677,10 @@ module Sisimai
         # @param    [String]     argv1  Reason name
         # @param    [True,False] argv2  false: Permanent error
         #                               true:  Temporary error
-        # @return   [String, Nil]       DSN or Nil if the 1st argument is missing
+        # @return   [String]            DSN or an empty string if the 1st argument is missing
         # @see      name
         def code(argv1 = nil, argv2 = false)
-          return nil unless argv1
-          return nil if argv1.empty?
+          return "" if argv1.to_s.empty?
 
           table = argv2 ? InternalCode[:temporary] : InternalCode[:permanent]
           code0 = table[argv1] || InternalCode[:permanent][argv1] || nil
@@ -690,13 +689,11 @@ module Sisimai
 
         # Convert from the status code to the reason string
         # @param    [String] argv1  Status code(DSN)
-        # @return   [String]        Reason name 
-        #           [Nil]           The first argument did not match with values in reason list
+        # @return   [String]        Reason name or an empty string
         # @see      code
         def name(argv1 = nil)
-          return nil unless argv1
-          return nil unless Sisimai::SMTP::Status.test(argv1)
-          return StandardCode[argv1] || nil
+          return "" unless Sisimai::SMTP::Status.test(argv1.to_s)
+          return StandardCode[argv1] || ""
         end
 
         # Check whether a status code is a valid code or not
@@ -705,29 +702,23 @@ module Sisimai
         # @see      code
         # @since v5.0.0
         def test(argv1 = '')
-          return false if argv1.to_s.empty?
-          return false if argv1.size < 5
-          return false if argv1.size > 7
+          return false if argv1.to_s.empty? || argv1.size < 5 || argv1.size > 7
 
           token = []
           argv1.split('.').each { |e| token << e.to_i }
           return false unless token.size == 3
-          return false if token[0]  < 2
-          return false if token[0] == 3
-          return false if token[0]  > 5
-          return false if token[1]  < 0
-          return false if token[1]  > 7
-          return false if token[2]  < 0
+          return false if token[0] < 2 || token[0] == 3 || token[0]  > 5
+          return false if token[1] < 0 || token[1]  > 7
+          return false if token[2] < 0
           return true
         end
 
         # Get a DSN code value from given string including DSN
         # @param    [String] argv1  String including DSN
         # @param    [String] argv2  An SMTP Reply Code or 2 or 4 or 5
-        # @return   [String, Nil]   An SMTP Status Code
+        # @return   [String]        An SMTP Status Code or an empty string
         def find(argv1 = nil, argv2 = '0')
-          return "" if argv1.to_s.empty?
-          return "" if argv1.size < 7
+          return "" if argv1.to_s.empty? || argv1.size < 7
 
           givenclass = argv2[0, 1]
           eestatuses = if givenclass == '2' || givenclass == '4' || givenclass == '5' 
@@ -856,8 +847,8 @@ module Sisimai
           end
           return statuscode if statuscode == codeinmesg
 
-          zeroindex1 = { 'field' => statuscode.index('.0')   || -1, 'error' => codeinmesg.index('.0')   || -1 }
-          zeroindex2 = { 'field' => statuscode.index('.0.0') || -1, 'error' => codeinmesg.index('.0.0') || -1 }
+          zeroindex1 = {'field' => statuscode.index('.0')   || -1, 'error' => codeinmesg.index('.0')   || -1}
+          zeroindex2 = {'field' => statuscode.index('.0.0') || -1, 'error' => codeinmesg.index('.0.0') || -1}
 
           if zeroindex2['field'] > 0
             # "Status:" field is "X.0.0"
@@ -896,8 +887,7 @@ module Sisimai
         # @param    string argv1  Status code
         # @return   bool          false: The delivery status code is not explicit
         def is_explicit(argv1 = '')
-          return false if argv1.nil?
-          return false if argv1.empty?
+          return false if argv1.nil? || argv1.empty?
           return false if argv1.size == 7 && argv1.start_with?("5.0.9", "4.0.9")
           return true
         end

data/lib/sisimai/smtp/transcript.rb

@@ -97,10 +97,8 @@ module Sisimai
             else
               # SMTP server sent a response "<<< response text"
               p = e.index('<<< '); next unless p == 0
+              e = e[4, e.size].sub(/\A<<<[ ]/, '')
 
-              e = e[4, e.size]
-
-              e.sub!(/\A<<<[ ]/, '')
               if cv = e.match(/\A([2-5]\d\d)[ ]/) then cx['response']['reply'] = cv[1] end
               if cv = e.match(/\A[245]\d\d[ ]([245][.]\d{1,3}[.]\d{1,3})[ ]/) then cx['response']['status'] = cv[1] end
               cx['response']['text'] << e
@@ -110,13 +108,6 @@ module Sisimai
           return nil if esmtp.size == 0
           return esmtp
         end
-
-
-
-
-          
-
-
       end
     end
   end

data/lib/sisimai/string.rb

@@ -11,31 +11,26 @@ module Sisimai
       # @param  [String]  addr1 Sender address
       # @param  [String]  addr2 Recipient address
       # @param  [Integer] epoch Machine time of the email bounce
-      # @return [String]        Message token(MD5 hex digest)
-      # @return [String]        Blank/failed to create token
+      # @return [String]        Message token(MD5 hex digest) or blank(failed to create token)
       # @see    http://en.wikipedia.org/wiki/ASCII
       def token(addr1, addr2, epoch)
-        return nil unless addr1.is_a?(::String)
-        return nil unless addr2.is_a?(::String)
-        return nil unless epoch.is_a?(Integer)
-        return nil if addr1.empty?
-        return nil if addr2.empty?
+        return "" unless addr1.is_a?(::String)
+        return "" unless addr2.is_a?(::String)
+        return "" unless epoch.is_a?(Integer)
+        return "" if addr1.empty? || addr2.empty?
 
         # Format: STX(0x02) Sender-Address RS(0x1e) Recipient-Address ETX(0x03)
         require 'digest/sha1'
-        return Digest::SHA1.hexdigest(
-          sprintf("\x02%s\x1e%s\x1e%d\x03", addr1.downcase, addr2.downcase, epoch)
-        )
+        return Digest::SHA1.hexdigest(sprintf("\x02%s\x1e%s\x1e%d\x03", addr1.downcase, addr2.downcase, epoch))
       end
 
       # The argument is 8-bit text or not
       # @param    [String] argvs  Any string to be checked
-      # @return   [True,False]    false: ASCII Characters only
-      #                           true:  Including 8-bit character
+      # @return   [Boolean]       false: ASCII Characters only, true: Including 8-bit character
       def is_8bit(argvs)
         v = argvs.to_s
-        return nil  if v.empty?
-        return true unless v =~ /\A[\x00-\x7f]*\z/
+        return false if v.empty?
+        return true  unless v =~ /\A[\x00-\x7f]*\z/
         return false
       end
 
@@ -54,12 +49,12 @@ module Sisimai
       # Check if each element of the 2nd argument is aligned in the 1st argument or not
       # @param    [String] argv1  String to be checked
       # @param    [Array]  argv2  List including the ordered strings
-      # @return   [Bool]          0, 1
+      # @return   [Boolean]
       # @since v5.0.0
       def aligned(argv1, argv2)
-        return nil if argv1.to_s.empty?
-        return nil unless argv2.is_a? Array
-        return nil unless argv2.size > 1
+        return false if argv1.to_s.empty?
+        return false unless argv2.is_a? Array
+        return false unless argv2.size > 1
 
         align = -1
         right =  0
@@ -80,7 +75,7 @@ module Sisimai
       # @param    [Boolean] loose Loose check flag
       # @return   [String]  Plain text
       def to_plain(argv1 = '', loose = false)
-        return nil if argv1.empty?
+        return "" if argv1.empty?
 
         plain = argv1
         if loose || plain =~ Match[:html] || plain =~ Match[:body]
@@ -89,20 +84,15 @@ module Sisimai
           # 3. <a href = 'http://...'>...</a> to " http://... "
           # 4. <a href = 'mailto:...'>...</a> to " Value <mailto:...> "
           plain.scrub!('?')
-          plain.gsub!(%r|<head>.+</head>|im, '')
-          plain.gsub!(%r|<style.+?>.+</style>|im, '')
-          plain.gsub!(%r|<a\s+href\s*=\s*['"](https?://.+?)['"].*?>(.*?)</a>|i, '[\2](\1)')
-          plain.gsub!(%r|<a\s+href\s*=\s*["']mailto:([^\s]+?)["']>(.*?)</a>|i, '[\2](mailto:\1)')
-
+          plain = plain.gsub(%r|<head>.+</head>|im, '')
+          plain = plain.gsub(%r|<style.+?>.+</style>|im, '')
+          plain = plain.gsub(%r|<a\s+href\s*=\s*['"](https?://.+?)['"].*?>(.*?)</a>|i, '[\2](\1)')
+          plain = plain.gsub(%r|<a\s+href\s*=\s*["']mailto:([^\s]+?)["']>(.*?)</a>|i, '[\2](mailto:\1)')
           plain = plain.gsub(/<[^<@>]+?>\s*/, ' ')              # Delete HTML tags except <neko@example.jp>
           plain = plain.gsub(/&lt;/, '<').gsub(/&gt;/, '>')     # Convert to angle brackets
           plain = plain.gsub(/&amp;/, '&').gsub(/&nbsp;/, ' ')  # Convert to "&"
           plain = plain.gsub(/&quot;/, '"').gsub(/&apos;/, "'") # Convert to " and '
-
-          if argv1.size > plain.size
-            plain  = plain.squeeze(' ')
-            plain << "\n"
-          end
+          plain = "#{plain.squeeze(' ')}\n" if argv1.size > plain.size
         end
 
         return plain
@@ -113,7 +103,7 @@ module Sisimai
       # @param    [String] argv2  Encoding name before converting
       # @return   [String]        UTF-8 Encoded string
       def to_utf8(argv1 = '', argv2 = nil)
-        return nil if argv1.empty?
+        return "" if argv1.empty?
 
         encodefrom = argv2 || false
         getencoded = ''

data/lib/sisimai/version.rb

@@ -1,4 +1,4 @@
 # Define the version number of Sisimai
 module Sisimai
-  VERSION = '5.3.0'.freeze
+  VERSION = '5.4.0'.freeze
 end

data/lib/sisimai.rb

@@ -1,6 +1,6 @@
-# Sisimai is a library that decodes complex and diverse bounce emails and outputs the results of
-# the delivery failure, such as the reason for the bounce and the recipient email address, in
-# structured data. It is also possible to output in JSON format. 
+# Sisimai (pronounced /ɕi.ɕi.ma.i/) is a library that decodes complex and diverse bounce emails and
+# outputs the results of the delivery failure, such as the reason for the bounce and the recipient
+# email address, in structured data. It is also possible to output in JSON format. 
 require 'sisimai/version'
 module Sisimai
   class << self
@@ -30,17 +30,17 @@ module Sisimai
       while r = mail.data.read do
         # Read and decode each email file
         path = mail.data.path
-        args = { data: r, hook: c___[0], origin: path, delivered: argv1[:delivered], vacation: argv1[:vacation] }
+        args = {data: r, hook: c___[0], origin: path, delivered: argv1[:delivered], vacation: argv1[:vacation]}
         fact = Sisimai::Fact.rise(**args) || []
 
         if c___[1]
           # Run the callback function specified with "c___" parameter of Sisimai.rise after reading
           # each email file in Maildir/ every time
-          args = { 'kind' => kind, 'mail' => r, 'path' => path, 'fact' => fact }
+          args = {'kind' => kind, 'mail' => r, 'path' => path, 'fact' => fact}
           begin
             c___[1].call(args) if c___[1].is_a?(Proc)
           rescue StandardError => ce
-            warn ' ***warning: Something is wrong in the second element of the ":c___":' << ce.to_s
+            warn ' ***warning: Something is wrong in the second element of the ":c___":' + ce.to_s
           end
         end
 
@@ -61,7 +61,7 @@ module Sisimai
     # @options argv1 [Lambda]  hook      Lambda object to be called back
     # @return        [String]            Decoded data as JSON text
     def dump(argv0, **argv1)
-      return nil unless argv0
+      return "" unless argv0
       nyaan = Sisimai.rise(argv0, **argv1) || []
 
       if RUBY_PLATFORM.start_with?('java')
@@ -81,14 +81,14 @@ module Sisimai
       table = {}
 
       %w[Lhost ARF RFC3464 RFC3834].each do |e|
-        r = 'Sisimai::' << e
+        r = "Sisimai::#{e}"
         require r.gsub('::', '/').downcase
 
         if e == 'Lhost'
           # Sisimai::Lhost::*
           Module.const_get(r).send(:index).each do |ee|
             # Load and get the value of "description" from each module
-            rr = 'Sisimai::' << e + '::' << ee
+            rr = "Sisimai::#{e}::#{ee}"
             require rr.gsub('::', '/').downcase
             table[rr.to_sym] = Module.const_get(rr).send(:description)
           end
@@ -112,7 +112,7 @@ module Sisimai
       names += %w[Delivered Feedback Undefined Vacation]
       while e = names.shift do
         # Call .description() method of Sisimai::Reason::*
-        r = 'Sisimai::Reason::' << e
+        r = "Sisimai::Reason::#{e}"
         require r.gsub('::', '/').downcase
         table[e.to_sym] = Module.const_get(r).send(:description)
       end
@@ -124,7 +124,7 @@ module Sisimai
     # @param    [String]    Error message text
     # @return   [String]    Reason text
     def match(argvs = '')
-      return nil if argvs.empty?
+      return "" if argvs.empty?
       require 'sisimai/reason'
       return Sisimai::Reason.match(argvs.downcase)
     end

data/set-of-emails/maildir/bsd/rhost-microsoft-06.eml

@@ -0,0 +1,45 @@
+Return-Path: <>
+Delivered-To: neko@e.nyaaaan.example.onmicrosoft.com
+Received: from relay.nyaaaan.example.onmicrosoft.com (unknown [192.0.2.25])
+	by ee.nyaaaan.example.onmicrosoft.com (Postfix) with ESMTPS id JFzCqYfyTkzvHbZW
+	for <neko@e.nyaaaan.example.onmicrosoft.com>; Sun, 25 May 2025 22:22:22 +0900 (JST)
+Received: from cat.example.co.jp (ip-192-0-2-225.us-west-1.compute.internal [192.0.2.225])
+	by relay.nyaaaan.example.onmicrosoft.com (Postfix) with ESMTPS id D09y2f7PVFzmfJf9
+	for <kijitora@nyaaaan.example.onmicrosoft.com>; Sun, 25 May 2025 22:22:22 +0900 (JST)
+Message-ID: <20250525222222.00002.nekochan@cat.example.co.jp>
+Date: 25 May 2025 22:22:22 +0900
+From: MAILER-DAEMON@cat.example.co.jp
+To: kijitora@nyaaaan.example.onmicrosoft.com
+Subject: failure notice
+
+Hi. This is the qmail-send program at cat.example.co.jp.
+I'm afraid I wasn't able to deliver your message to the following addresses.
+This is a permanent error; I've given up. Sorry it didn't work out.
+
+<sabineko@example.onmicrosoft.com>:
+198.51.100.25 failed after I sent the message.
+Remote host said: 550 5.7.515 Access denied, sending domain NYAAAAN.EXAMPLE.JP doesn't meet the required authentication level. The sender's domain in the 5322.From address doesn't meet the authentication requirements defined for the sender. To learn how to fix this see: https://go.microsoft.com/fwlink/p/?linkid=2319303 Spf= Fail , Dkim= Pass , DMARC= Pass [0000000000000.JPNP255.PROD.OUTLOOK.COM 2025-05-25T22:22:22.000Z 0000000000000EEE] [0000000000000.jpnprd00.prod.outlook.com 2025-05-25T22:22:22.000Z 0000000000000EEE] [0000000000000EE.apcprd00.prod.outlook.com 2025-05-25T22:22:22.000Z 0000000000000EEE]
+
+--- Below this line is a copy of the message.
+
+Return-Path: <kijitora@nyaaaan.example.onmicrosoft.com>
+Received: (qmail 32768 invoked by uid 99); 25 May 2025 22:22:22 +0900
+Delivered-To: mikeneko@example.org
+Received: (qmail 32767 invoked by uid 99); 25 May 2025 22:22:22 +0900
+Received: from relay-2.nyaaaan.example.onmicrosoft.com (203.0.113.25)
+  by cat.example.co.jp with ESMTPS (AES256-GCM-SHA384 encrypted); 25 May 2025 22:22:22 +0900
+Received: from relay-1.nyaaaan.example.onmicrosoft.com (unknown [192.0.2.254])
+	by relay-2.nyaaaan.example.onmicrosoft.com (Postfix) with ESMTP id djK8m53Kqpzf8pK9
+	for <mikeneko@example.org>; Sun, 25 May 2025 22:22:22 +0900 (JST)
+DKIM-Filter: OpenDKIM Filter v2.11.0 relay-2.nyaaaan.example.onmicrosoft.com djK8m53Kqpzf8pK9
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nyaaaan.example.onmicrosoft.com;
+Content-Type: text/plain; charset=us-ascii
+MIME-Version: 1.0
+From: <kijitora@nyaaaan.example.onmicrosoft.com>
+Date: Sun, 25 May 2025 22:22:22 +0900
+Subject: Nyaaaan?
+Message-Id: <5E82FFFE9D95.88616A92ACCB@relay-1.nyaaaan.example.onmicrosoft.com>
+To: <mikeneko@example.org>
+
+Nyaaaan?
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sisimai
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.4.0
 platform: ruby
 authors:
 - azumakuniyuki
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-28 00:00:00.000000000 Z
+date: 2025-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -813,6 +813,7 @@ files:
 - set-of-emails/maildir/bsd/rhost-microsoft-03.eml
 - set-of-emails/maildir/bsd/rhost-microsoft-04.eml
 - set-of-emails/maildir/bsd/rhost-microsoft-05.eml
+- set-of-emails/maildir/bsd/rhost-microsoft-06.eml
 - set-of-emails/maildir/bsd/rhost-mimecast-01.eml
 - set-of-emails/maildir/bsd/rhost-mimecast-02.eml
 - set-of-emails/maildir/bsd/rhost-nttdocomo-01.eml