net-imap 0.5.4 → 0.5.6

data/lib/net/imap/response_parser.rb

@@ -13,13 +13,17 @@ module Net
 
       attr_reader :config
 
-      # :call-seq: Net::IMAP::ResponseParser.new -> Net::IMAP::ResponseParser
+      # Creates a new ResponseParser.
+      #
+      # When +config+ is frozen or global, the parser #config inherits from it.
+      # Otherwise, +config+ will be used directly.
       def initialize(config: Config.global)
         @str = nil
         @pos = nil
         @lex_state = nil
         @token = nil
         @config = Config[config]
+        @config = @config.new if @config == Config.global || @config.frozen?
       end
 
       # :call-seq:
@@ -734,7 +738,7 @@ module Net
         when "EXISTS"     then mailbox_data__exists      # RFC3501, RFC9051
         when "ESEARCH"    then esearch_response          # RFC4731, RFC9051, etc
         when "VANISHED"   then expunged_resp             # RFC7162
-        when "UIDFETCH"   then uidfetch_resp             # (draft) UIDONLY
+        when "UIDFETCH"   then uidfetch_resp             # RFC9586
         when "SEARCH"     then mailbox_data__search      # RFC3501 (obsolete)
         when "CAPABILITY" then capability_data__untagged # RFC3501, RFC9051
         when "FLAGS"      then mailbox_data__flags       # RFC3501, RFC9051
@@ -787,7 +791,6 @@ module Net
       def response_data__ignored; response_data__unhandled(IgnoredResponse) end
       alias response_data__noop     response_data__ignored
 
-      alias uidfetch_resp           response_data__unhandled
       alias listrights_data         response_data__unhandled
       alias myrights_data           response_data__unhandled
       alias metadata_resp           response_data__unhandled
@@ -848,6 +851,14 @@ module Net
         UntaggedResponse.new(name, data, @str)
       end
 
+      #   uidfetch-resp = uniqueid SP "UIDFETCH" SP msg-att
+      def uidfetch_resp
+        uid  = uniqueid;         SP!
+        name = label "UIDFETCH"; SP!
+        data = UIDFetchData.new(uid, msg_att(uid))
+        UntaggedResponse.new(name, data, @str)
+      end
+
       def response_data__simple_numeric
         data = nz_number; SP!
         name = tagged_ext_label
@@ -1935,6 +1946,9 @@ module Net
       #
       # RFC8474: OBJECTID
       #   resp-text-code   =/ "MAILBOXID" SP "(" objectid ")"
+      #
+      # RFC9586: UIDONLY
+      #   resp-text-code   =/ "UIDREQUIRED"
       def resp_text_code
         name = resp_text_code__name
         data =
@@ -1957,6 +1971,7 @@ module Net
           when "HIGHESTMODSEQ"      then SP!; mod_sequence_value   # CONDSTORE
           when "MODIFIED"           then SP!; sequence_set         # CONDSTORE
           when "MAILBOXID"          then SP!; parens__objectid     # RFC8474: OBJECTID
+          when "UIDREQUIRED"        then                           # RFC9586: UIDONLY
           else
             SP? and text_chars_except_rbra
           end
@@ -1986,11 +2001,10 @@ module Net
       #
       # n.b, uniqueid ⊂ uid-set.  To avoid inconsistent return types, we always
       # match uid_set even if that returns a single-member array.
-      #
       def resp_code_apnd__data
         validity = number; SP!
         dst_uids = uid_set # uniqueid ⊂ uid-set
-        UIDPlusData.new(validity, nil, dst_uids)
+        AppendUID(validity, dst_uids)
       end
 
       # already matched:  "COPYUID"
@@ -2000,7 +2014,25 @@ module Net
         validity = number;  SP!
         src_uids = uid_set; SP!
         dst_uids = uid_set
-        UIDPlusData.new(validity, src_uids, dst_uids)
+        CopyUID(validity, src_uids, dst_uids)
+      end
+
+      def AppendUID(...) DeprecatedUIDPlus(...) || AppendUIDData.new(...) end
+      def CopyUID(...)   DeprecatedUIDPlus(...) || CopyUIDData.new(...)   end
+
+      # TODO: remove this code in the v0.6.0 release
+      def DeprecatedUIDPlus(validity, src_uids = nil, dst_uids)
+        return unless config.parser_use_deprecated_uidplus_data
+        compact_uid_sets = [src_uids, dst_uids].compact
+        count = compact_uid_sets.map { _1.count_with_duplicates }.max
+        max   = config.parser_max_deprecated_uidplus_data_size
+        if count <= max
+          src_uids &&= src_uids.each_ordered_number.to_a
+          dst_uids   = dst_uids.each_ordered_number.to_a
+          UIDPlusData.new(validity, src_uids, dst_uids)
+        elsif config.parser_use_deprecated_uidplus_data != :up_to_max_size
+          parse_error("uid-set is too large: %d > %d", count, max)
+        end
       end
 
       ADDRESS_REGEXP = /\G
@@ -2126,15 +2158,9 @@ module Net
       #      uniqueid        = nz-number
       #                          ; Strictly ascending
       def uid_set
-        token = match(T_NUMBER, T_ATOM)
-        case token.symbol
-        when T_NUMBER then [Integer(token.value)]
-        when T_ATOM
-          token.value.split(",").flat_map {|range|
-            range = range.split(":").map {|uniqueid| Integer(uniqueid) }
-            range.size == 1 ? range : Range.new(range.min, range.max).to_a
-          }
-        end
+        set = sequence_set
+        parse_error("uid-set cannot contain '*'") if set.include_star?
+        set
       end
 
       def nil_atom

data/lib/net/imap/sasl/anonymous_authenticator.rb

@@ -5,7 +5,7 @@ module Net
     module SASL
 
       # Authenticator for the "+ANONYMOUS+" SASL mechanism, as specified by
-      # RFC-4505[https://tools.ietf.org/html/rfc4505].  See
+      # RFC-4505[https://www.rfc-editor.org/rfc/rfc4505].  See
       # Net::IMAP#authenticate.
       class AnonymousAuthenticator
 
@@ -13,7 +13,7 @@ module Net
         # characters in length.
         #
         # If it contains an "@" sign, the message must be a valid email address
-        # (+addr-spec+ from RFC-2822[https://tools.ietf.org/html/rfc2822]).
+        # (+addr-spec+ from RFC-2822[https://www.rfc-editor.org/rfc/rfc2822]).
         # Email syntax is _not_ validated by AnonymousAuthenticator.
         #
         # Otherwise, it can be any UTF8 string which is permitted by the
@@ -25,7 +25,7 @@ module Net
         #   new(anonymous_message:  "", **) -> authenticator
         #
         # Creates an Authenticator for the "+ANONYMOUS+" SASL mechanism, as
-        # specified in RFC-4505[https://tools.ietf.org/html/rfc4505].  To use
+        # specified in RFC-4505[https://www.rfc-editor.org/rfc/rfc4505].  To use
         # this, see Net::IMAP#authenticate or your client's authentication
         # method.
         #

data/lib/net/imap/sasl/cram_md5_authenticator.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 # Authenticator for the "+CRAM-MD5+" SASL mechanism, specified in
-# RFC2195[https://tools.ietf.org/html/rfc2195].  See Net::IMAP#authenticate.
+# RFC2195[https://www.rfc-editor.org/rfc/rfc2195].  See Net::IMAP#authenticate.
 #
 # == Deprecated
 #
 # +CRAM-MD5+ is obsolete and insecure.  It is included for compatibility with
 # existing servers.
-# {draft-ietf-sasl-crammd5-to-historic}[https://tools.ietf.org/html/draft-ietf-sasl-crammd5-to-historic-00.html]
+# {draft-ietf-sasl-crammd5-to-historic}[https://www.rfc-editor.org/rfc/draft-ietf-sasl-crammd5-to-historic-00.html]
 # recommends using +SCRAM-*+ or +PLAIN+ protected by TLS instead.
 #
-# Additionally, RFC8314[https://tools.ietf.org/html/rfc8314] discourage the use
+# Additionally, RFC8314[https://www.rfc-editor.org/rfc/rfc8314] discourage the use
 # of cleartext and recommends TLS version 1.2 or greater be used for all
 # traffic.  With TLS +CRAM-MD5+ is okay, but so is +PLAIN+
 class Net::IMAP::SASL::CramMD5Authenticator

data/lib/net/imap/sasl/digest_md5_authenticator.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 # Net::IMAP authenticator for the +DIGEST-MD5+ SASL mechanism type, specified
-# in RFC-2831[https://tools.ietf.org/html/rfc2831].  See Net::IMAP#authenticate.
+# in RFC-2831[https://www.rfc-editor.org/rfc/rfc2831].  See Net::IMAP#authenticate.
 #
 # == Deprecated
 #
 # "+DIGEST-MD5+" has been deprecated by
-# RFC-6331[https://tools.ietf.org/html/rfc6331] and should not be relied on for
+# RFC-6331[https://www.rfc-editor.org/rfc/rfc6331] and should not be relied on for
 # security.  It is included for compatibility with existing servers.
 class Net::IMAP::SASL::DigestMD5Authenticator
   DataFormatError    = Net::IMAP::DataFormatError
@@ -37,10 +37,10 @@ class Net::IMAP::SASL::DigestMD5Authenticator
 
   # Authentication identity: the identity that matches the #password.
   #
-  # RFC-2831[https://tools.ietf.org/html/rfc2831] uses the term +username+.
+  # RFC-2831[https://www.rfc-editor.org/rfc/rfc2831] uses the term +username+.
   # "Authentication identity" is the generic term used by
-  # RFC-4422[https://tools.ietf.org/html/rfc4422].
-  # RFC-4616[https://tools.ietf.org/html/rfc4616] and many later RFCs abbreviate
+  # RFC-4422[https://www.rfc-editor.org/rfc/rfc4422].
+  # RFC-4616[https://www.rfc-editor.org/rfc/rfc4616] and many later RFCs abbreviate
   # this to +authcid+.
   attr_reader :username
   alias authcid username
@@ -85,7 +85,7 @@ class Net::IMAP::SASL::DigestMD5Authenticator
   # must be set appropriately to use authenticators in other protocols.
   #
   # If an IANA-registered name isn't available, GSS-API
-  # (RFC-2743[https://tools.ietf.org/html/rfc2743]) allows the generic name
+  # (RFC-2743[https://www.rfc-editor.org/rfc/rfc2743]) allows the generic name
   # "host".
   attr_reader :service
 
@@ -93,7 +93,7 @@ class Net::IMAP::SASL::DigestMD5Authenticator
   #
   # +service_name+ will be ignored when it is +nil+ or identical to +host+.
   #
-  # From RFC-2831[https://tools.ietf.org/html/rfc2831]:
+  # From RFC-2831[https://www.rfc-editor.org/rfc/rfc2831]:
   # >>>
   #     The service is considered to be replicated if the client's
   #     service-location process involves resolution using standard DNS lookup
@@ -176,7 +176,7 @@ class Net::IMAP::SASL::DigestMD5Authenticator
     @nc, @stage = {}, STAGE_ONE
   end
 
-  # From RFC-2831[https://tools.ietf.org/html/rfc2831]:
+  # From RFC-2831[https://www.rfc-editor.org/rfc/rfc2831]:
   # >>>
   #     Indicates the principal name of the service with which the client wishes
   #     to connect, formed from the serv-type, host, and serv-name.  For

data/lib/net/imap/sasl/external_authenticator.rb

@@ -5,7 +5,7 @@ module Net
     module SASL
 
       # Authenticator for the "+EXTERNAL+" SASL mechanism, as specified by
-      # RFC-4422[https://tools.ietf.org/html/rfc4422].  See
+      # RFC-4422[https://www.rfc-editor.org/rfc/rfc4422].  See
       # Net::IMAP#authenticate.
       #
       # The EXTERNAL mechanism requests that the server use client credentials
@@ -33,7 +33,7 @@ module Net
         #   new(username = nil, **) -> authenticator
         #
         # Creates an Authenticator for the "+EXTERNAL+" SASL mechanism, as
-        # specified in RFC-4422[https://tools.ietf.org/html/rfc4422].  To use
+        # specified in RFC-4422[https://www.rfc-editor.org/rfc/rfc4422].  To use
         # this, see Net::IMAP#authenticate or your client's authentication
         # method.
         #

data/lib/net/imap/sasl/gs2_header.rb

@@ -5,15 +5,15 @@ module Net
     module SASL
 
       # Originally defined for the GS2 mechanism family in
-      # RFC5801[https://tools.ietf.org/html/rfc5801],
+      # RFC5801[https://www.rfc-editor.org/rfc/rfc5801],
       # several different mechanisms start with a GS2 header:
-      # * +GS2-*+       --- RFC5801[https://tools.ietf.org/html/rfc5801]
-      # * +SCRAM-*+     --- RFC5802[https://tools.ietf.org/html/rfc5802]
+      # * +GS2-*+       --- RFC5801[https://www.rfc-editor.org/rfc/rfc5801]
+      # * +SCRAM-*+     --- RFC5802[https://www.rfc-editor.org/rfc/rfc5802]
       #   (ScramAuthenticator)
-      # * +SAML20+      --- RFC6595[https://tools.ietf.org/html/rfc6595]
-      # * +OPENID20+    --- RFC6616[https://tools.ietf.org/html/rfc6616]
-      # * +OAUTH10A+    --- RFC7628[https://tools.ietf.org/html/rfc7628]
-      # * +OAUTHBEARER+ --- RFC7628[https://tools.ietf.org/html/rfc7628]
+      # * +SAML20+      --- RFC6595[https://www.rfc-editor.org/rfc/rfc6595]
+      # * +OPENID20+    --- RFC6616[https://www.rfc-editor.org/rfc/rfc6616]
+      # * +OAUTH10A+    --- RFC7628[https://www.rfc-editor.org/rfc/rfc7628]
+      # * +OAUTHBEARER+ --- RFC7628[https://www.rfc-editor.org/rfc/rfc7628]
       #   (OAuthBearerAuthenticator)
       #
       # Classes that include this module must implement +#authzid+.

data/lib/net/imap/sasl/login_authenticator.rb

@@ -3,9 +3,9 @@
 # Authenticator for the "+LOGIN+" SASL mechanism.  See Net::IMAP#authenticate.
 #
 # +LOGIN+ authentication sends the password in cleartext.
-# RFC3501[https://tools.ietf.org/html/rfc3501] encourages servers to disable
+# RFC3501[https://www.rfc-editor.org/rfc/rfc3501] encourages servers to disable
 # cleartext authentication until after TLS has been negotiated.
-# RFC8314[https://tools.ietf.org/html/rfc8314] recommends TLS version 1.2 or
+# RFC8314[https://www.rfc-editor.org/rfc/rfc8314] recommends TLS version 1.2 or
 # greater be used for all traffic, and deprecate cleartext access ASAP.  +LOGIN+
 # can be secured by TLS encryption.
 #

data/lib/net/imap/sasl/oauthbearer_authenticator.rb

@@ -7,7 +7,7 @@ module Net
     module SASL
 
       # Abstract base class for the SASL mechanisms defined in
-      # RFC7628[https://tools.ietf.org/html/rfc7628]:
+      # RFC7628[https://www.rfc-editor.org/rfc/rfc7628]:
       # * OAUTHBEARER[rdoc-ref:OAuthBearerAuthenticator]
       #   (OAuthBearerAuthenticator)
       # * OAUTH10A
@@ -52,7 +52,7 @@ module Net
         # this may hold information about the failure reason, as JSON.
         attr_reader :last_server_response
 
-        # Creates an RFC7628[https://tools.ietf.org/html/rfc7628] OAuth
+        # Creates an RFC7628[https://www.rfc-editor.org/rfc/rfc7628] OAuth
         # authenticator.
         #
         # ==== Parameters
@@ -126,12 +126,12 @@ module Net
       end
 
       # Authenticator for the "+OAUTHBEARER+" SASL mechanism, specified in
-      # RFC7628[https://tools.ietf.org/html/rfc7628].  Authenticates using OAuth
-      # 2.0 bearer tokens, as described in
-      # RFC6750[https://tools.ietf.org/html/rfc6750].  Use via
+      # RFC7628[https://www.rfc-editor.org/rfc/rfc7628].  Authenticates using
+      # OAuth 2.0 bearer tokens, as described in
+      # RFC6750[https://www.rfc-editor.org/rfc/rfc6750].  Use via
       # Net::IMAP#authenticate.
       #
-      # RFC6750[https://tools.ietf.org/html/rfc6750] requires Transport Layer
+      # RFC6750[https://www.rfc-editor.org/rfc/rfc6750] requires Transport Layer
       # Security (TLS) to secure the protocol interaction between the client and
       # the resource server.  TLS _MUST_ be used for +OAUTHBEARER+ to protect
       # the bearer token.

data/lib/net/imap/sasl/plain_authenticator.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 # Authenticator for the "+PLAIN+" SASL mechanism, specified in
-# RFC-4616[https://tools.ietf.org/html/rfc4616].  See Net::IMAP#authenticate.
+# RFC-4616[https://www.rfc-editor.org/rfc/rfc4616].  See Net::IMAP#authenticate.
 #
 # +PLAIN+ authentication sends the password in cleartext.
-# RFC-3501[https://tools.ietf.org/html/rfc3501] encourages servers to disable
+# RFC-3501[https://www.rfc-editor.org/rfc/rfc3501] encourages servers to disable
 # cleartext authentication until after TLS has been negotiated.
-# RFC-8314[https://tools.ietf.org/html/rfc8314] recommends TLS version 1.2 or
+# RFC-8314[https://www.rfc-editor.org/rfc/rfc8314] recommends TLS version 1.2 or
 # greater be used for all traffic, and deprecate cleartext access ASAP.  +PLAIN+
 # can be secured by TLS encryption.
 class Net::IMAP::SASL::PlainAuthenticator
@@ -16,11 +16,11 @@ class Net::IMAP::SASL::PlainAuthenticator
 
   # Authentication identity: the identity that matches the #password.
   #
-  # RFC-2831[https://tools.ietf.org/html/rfc2831] uses the term +username+.
+  # RFC-2831[https://www.rfc-editor.org/rfc/rfc2831] uses the term +username+.
   # "Authentication identity" is the generic term used by
-  # RFC-4422[https://tools.ietf.org/html/rfc4422].
-  # RFC-4616[https://tools.ietf.org/html/rfc4616] and many later RFCs abbreviate
-  # this to +authcid+.
+  # RFC-4422[https://www.rfc-editor.org/rfc/rfc4422].
+  # RFC-4616[https://www.rfc-editor.org/rfc/rfc4616] and many later RFCs
+  # abbreviate this to +authcid+.
   attr_reader :username
   alias authcid username
 

data/lib/net/imap/sasl/scram_authenticator.rb

@@ -11,7 +11,7 @@ module Net
     module SASL
 
       # Abstract base class for the "+SCRAM-*+" family of SASL mechanisms,
-      # defined in RFC5802[https://tools.ietf.org/html/rfc5802].  Use via
+      # defined in RFC5802[https://www.rfc-editor.org/rfc/rfc5802].  Use via
       # Net::IMAP#authenticate.
       #
       # Directly supported:
@@ -99,11 +99,11 @@ module Net
 
         # Authentication identity: the identity that matches the #password.
         #
-        # RFC-2831[https://tools.ietf.org/html/rfc2831] uses the term +username+.
-        # "Authentication identity" is the generic term used by
-        # RFC-4422[https://tools.ietf.org/html/rfc4422].
-        # RFC-4616[https://tools.ietf.org/html/rfc4616] and many later RFCs abbreviate
-        # this to +authcid+.
+        # RFC-2831[https://www.rfc-editor.org/rfc/rfc2831] uses the term
+        # +username+.  "Authentication identity" is the generic term used by
+        # RFC-4422[https://www.rfc-editor.org/rfc/rfc4422].
+        # RFC-4616[https://www.rfc-editor.org/rfc/rfc4616] and many later RFCs
+        # abbreviate this to +authcid+.
         attr_reader :username
         alias authcid username
 
@@ -263,7 +263,7 @@ module Net
       end
 
       # Authenticator for the "+SCRAM-SHA-1+" SASL mechanism, defined in
-      # RFC5802[https://tools.ietf.org/html/rfc5802].
+      # RFC5802[https://www.rfc-editor.org/rfc/rfc5802].
       #
       # Uses the "SHA-1" digest algorithm from OpenSSL::Digest.
       #
@@ -273,7 +273,7 @@ module Net
       end
 
       # Authenticator for the "+SCRAM-SHA-256+" SASL mechanism, defined in
-      # RFC7677[https://tools.ietf.org/html/rfc7677].
+      # RFC7677[https://www.rfc-editor.org/rfc/rfc7677].
       #
       # Uses the "SHA-256" digest algorithm from OpenSSL::Digest.
       #

data/lib/net/imap/sasl.rb

@@ -5,7 +5,7 @@ module Net
 
     # Pluggable authentication mechanisms for protocols which support SASL
     # (Simple Authentication and Security Layer), such as IMAP4, SMTP, LDAP, and
-    # XMPP.  {RFC-4422}[https://tools.ietf.org/html/rfc4422] specifies the
+    # XMPP.  {RFC-4422}[https://www.rfc-editor.org/rfc/rfc4422] specifies the
     # common \SASL framework:
     # >>>
     #   SASL is conceptually a framework that provides an abstraction layer

data/lib/net/imap/search_result.rb

@@ -100,10 +100,10 @@ module Net
       #    data.to_s("SORT")   # => "* SORT 2 8 32 128 256 512"
       #    data.to_s(nil)      # => "2 8 32 128 256 512"
       #
-      #    data = Net::IMAP::SearchResult[1, 3, 16, 1024, modseq: 2048].to_s
+      #    data = Net::IMAP::SearchResult[1, 3, 16, 1024, modseq: 2048]
       #    data.to_s           # => "* SEARCH 1 3 16 1024 (MODSEQ 2048)"
       #    data.to_s("SORT")   # => "* SORT 1 3 16 1024 (MODSEQ 2048)"
-      #    data.to_s           # => "1 3 16 1024 (MODSEQ 2048)"
+      #    data.to_s(nil)      # => "1 3 16 1024 (MODSEQ 2048)"
       #
       def to_s(type = "SEARCH")
         str = +""