net-imap 0.4.19 → 0.5.0

data/lib/net/imap.rb

@@ -719,7 +719,7 @@ module Net
   # * {IMAP URLAUTH Authorization Mechanism Registry}[https://www.iana.org/assignments/urlauth-authorization-mechanism-registry/urlauth-authorization-mechanism-registry.xhtml]
   #
   class IMAP < Protocol
-    VERSION = "0.4.19"
+    VERSION = "0.5.0"
 
     # Aliases for supported capabilities, to be used with the #enable command.
     ENABLE_ALIASES = {
@@ -946,9 +946,6 @@ module Net
       @sock = tcp_socket(@host, @port)
       start_tls_session if ssl_ctx
       start_imap_connection
-
-      # DEPRECATED: to remove in next version
-      @client_thread = Thread.current
     end
 
     # Returns true after the TLS negotiation has completed and the remote
@@ -956,11 +953,6 @@ module Net
     # but peer verification was disabled.
     def tls_verified?; @tls_verified end
 
-    def client_thread # :nodoc:
-      warn "Net::IMAP#client_thread is deprecated and will be removed soon."
-      @client_thread
-    end
-
     # Disconnects from the server.
     #
     # Related: #logout, #logout!
@@ -1222,21 +1214,13 @@ module Net
     #
     def starttls(**options)
       @ssl_ctx_params, @ssl_ctx = build_ssl_ctx(options)
-      error = nil
-      ok = send_command("STARTTLS") do |resp|
+      send_command("STARTTLS") do |resp|
         if resp.kind_of?(TaggedResponse) && resp.name == "OK"
           clear_cached_capabilities
           clear_responses
           start_tls_session
         end
-      rescue Exception => error
-        raise # note that the error backtrace is in the receiver_thread
-      end
-      if error
-        disconnect
-        raise error
       end
-      ok
     end
 
     # :call-seq:
@@ -1252,6 +1236,9 @@ module Net
     # +SASL-IR+ capability, below).  Defaults to the #config value for
     # {sasl_ir}[rdoc-ref:Config#sasl_ir], which defaults to +true+.
     #
+    # The +registry+ kwarg can be used to select the mechanism implementation
+    # from a custom registry.  See SASL.authenticator and SASL::Authenticators.
+    #
     # All other arguments are forwarded to the registered SASL authenticator for
     # the requested mechanism.  <em>The documentation for each individual
     # mechanism must be consulted for its specific parameters.</em>
@@ -1346,29 +1333,9 @@ module Net
     # Previously cached #capabilities will be cleared when this method
     # completes.  If the TaggedResponse to #authenticate includes updated
     # capabilities, they will be cached.
-    def authenticate(mechanism, *creds,
-                     sasl_ir: config.sasl_ir,
-                     **props, &callback)
-      mechanism = mechanism.to_s.tr("_", "-").upcase
-      authenticator = SASL.authenticator(mechanism, *creds, **props, &callback)
-      cmdargs = ["AUTHENTICATE", mechanism]
-      if sasl_ir && capable?("SASL-IR") && auth_capable?(mechanism) &&
-          authenticator.respond_to?(:initial_response?) &&
-          authenticator.initial_response?
-        response = authenticator.process(nil)
-        cmdargs << (response.empty? ? "=" : [response].pack("m0"))
-      end
-      result = send_command_with_continuations(*cmdargs) {|data|
-        challenge = data.unpack1("m")
-        response  = authenticator.process challenge
-        [response].pack("m0")
-      }
-      if authenticator.respond_to?(:done?) && !authenticator.done?
-        logout!
-        raise SASL::AuthenticationIncomplete, result
-      end
-      @capabilities = capabilities_from_resp_code result
-      result
+    def authenticate(*args, sasl_ir: config.sasl_ir, **props, &callback)
+      sasl_adapter.authenticate(*args, sasl_ir: sasl_ir, **props, &callback)
+        .tap { @capabilities = capabilities_from_resp_code _1 }
     end
 
     # Sends a {LOGIN command [IMAP4rev1 §6.2.3]}[https://www.rfc-editor.org/rfc/rfc3501#section-6.2.3]
@@ -1388,13 +1355,9 @@ module Net
     # ===== Capabilities
     #
     # An IMAP client MUST NOT call #login when the server advertises the
-    # +LOGINDISABLED+ capability.
-    #
-    #    if imap.capability? "LOGINDISABLED"
-    #      raise "Remote server has disabled the login command"
-    #    else
-    #      imap.login username, password
-    #    end
+    # +LOGINDISABLED+ capability.  By default, Net::IMAP will raise a
+    # LoginDisabledError when that capability is present.  See
+    # Config#enforce_logindisabled.
     #
     # Server capabilities may change after #starttls, #login, and #authenticate.
     # Cached capabilities _must_ be invalidated after this method completes.
@@ -1402,6 +1365,9 @@ module Net
     # ResponseCode.
     #
     def login(user, password)
+      if enforce_logindisabled? && capability?("LOGINDISABLED")
+        raise LoginDisabledError
+      end
       send_command("LOGIN", user, password)
         .tap { @capabilities = capabilities_from_resp_code _1 }
     end
@@ -1958,7 +1924,7 @@ module Net
     # [RFC4315[https://www.rfc-editor.org/rfc/rfc4315.html]].
     def uid_expunge(uid_set)
       synchronize do
-        send_command("UID EXPUNGE", MessageSet.new(uid_set))
+        send_command("UID EXPUNGE", SequenceSet.new(uid_set))
         clear_responses("EXPUNGE")
       end
     end
@@ -2616,7 +2582,7 @@ module Net
         when :raise
           raise ArgumentError, RESPONSES_DEPRECATION_MSG
         when :warn
-          warn(RESPONSES_DEPRECATION_MSG, uplevel: 1)
+          warn(RESPONSES_DEPRECATION_MSG, uplevel: 1, category: :deprecated)
         when :frozen_dup
           synchronize {
             responses = @responses.transform_values(&:freeze)
@@ -2965,6 +2931,14 @@ module Net
       end
     end
 
+    def enforce_logindisabled?
+      if config.enforce_logindisabled == :when_capabilities_cached
+        capabilities_cached?
+      else
+        config.enforce_logindisabled
+      end
+    end
+
     def search_internal(cmd, keys, charset)
       if keys.instance_of?(String)
         keys = [RawData.new(keys)]
@@ -2998,9 +2972,9 @@ module Net
       synchronize do
         clear_responses("FETCH")
         if mod
-          send_command(cmd, MessageSet.new(set), attr, mod)
+          send_command(cmd, SequenceSet.new(set), attr, mod)
         else
-          send_command(cmd, MessageSet.new(set), attr)
+          send_command(cmd, SequenceSet.new(set), attr)
         end
         clear_responses("FETCH")
       end
@@ -3008,7 +2982,7 @@ module Net
 
     def store_internal(cmd, set, attr, flags, unchangedsince: nil)
       attr = RawData.new(attr) if attr.instance_of?(String)
-      args = [MessageSet.new(set)]
+      args = [SequenceSet.new(set)]
       args << ["UNCHANGEDSINCE", Integer(unchangedsince)] if unchangedsince
       args << attr << flags
       synchronize do
@@ -3019,7 +2993,7 @@ module Net
     end
 
     def copy_internal(cmd, set, mailbox)
-      send_command(cmd, MessageSet.new(set), mailbox)
+      send_command(cmd, SequenceSet.new(set), mailbox)
     end
 
     def sort_internal(cmd, sort_keys, search_keys, charset)
@@ -3050,7 +3024,7 @@ module Net
       keys.collect! do |i|
         case i
         when -1, Range, Array
-          MessageSet.new(i)
+          SequenceSet.new(i)
         else
           i
         end

data/net-imap.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Ruby client api for Internet Message Access Protocol}
   spec.description   = %q{Ruby client api for Internet Message Access Protocol}
   spec.homepage      = "https://github.com/ruby/net-imap"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.3")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
   spec.licenses       = ["Ruby", "BSD-2-Clause"]
 
   spec.metadata["homepage_uri"] = spec.homepage

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: net-imap
 version: !ruby/object:Gem::Version
-  version: 0.4.19
+  version: 0.5.0
 platform: ruby
 authors:
 - Shugo Maeda
 - nicholas a. evans
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-02-07 00:00:00.000000000 Z
+date: 2024-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-protocol
@@ -94,7 +95,6 @@ files:
 - lib/net/imap/stringprep/saslprep_tables.rb
 - lib/net/imap/stringprep/tables.rb
 - lib/net/imap/stringprep/trace.rb
-- lib/net/imap/uidplus_data.rb
 - net-imap.gemspec
 - rakelib/benchmarks.rake
 - rakelib/rdoc.rake
@@ -110,6 +110,7 @@ metadata:
   homepage_uri: https://github.com/ruby/net-imap
   source_code_uri: https://github.com/ruby/net-imap
   changelog_uri: https://github.com/ruby/net-imap/releases
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -117,14 +118,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.3
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.5.16
+signing_key: 
 specification_version: 4
 summary: Ruby client api for Internet Message Access Protocol
 test_files: []

data/lib/net/imap/uidplus_data.rb

@@ -1,326 +0,0 @@
-# frozen_string_literal: true
-
-module Net
-  class IMAP < Protocol
-
-    # *NOTE:* <em>UIDPlusData is deprecated and will be removed in the +0.6.0+
-    # release.</em>  To use AppendUIDData and CopyUIDData before +0.6.0+, set
-    # Config#parser_use_deprecated_uidplus_data to +false+.
-    #
-    # UIDPlusData represents the ResponseCode#data that accompanies the
-    # +APPENDUID+ and +COPYUID+ {response codes}[rdoc-ref:ResponseCode].
-    #
-    # A server that supports +UIDPLUS+ should send UIDPlusData in response to
-    # the append[rdoc-ref:Net::IMAP#append], copy[rdoc-ref:Net::IMAP#copy],
-    # move[rdoc-ref:Net::IMAP#move], {uid copy}[rdoc-ref:Net::IMAP#uid_copy],
-    # and {uid move}[rdoc-ref:Net::IMAP#uid_move] commands---unless the
-    # destination mailbox reports +UIDNOTSTICKY+.
-    #
-    # Note that append[rdoc-ref:Net::IMAP#append], copy[rdoc-ref:Net::IMAP#copy]
-    # and {uid_copy}[rdoc-ref:Net::IMAP#uid_copy] return UIDPlusData in their
-    # TaggedResponse.  But move[rdoc-ref:Net::IMAP#copy] and
-    # {uid_move}[rdoc-ref:Net::IMAP#uid_move] _should_ send UIDPlusData in an
-    # UntaggedResponse response before sending their TaggedResponse.  However
-    # some servers do send UIDPlusData in the TaggedResponse for +MOVE+
-    # commands---this complies with the older +UIDPLUS+ specification but is
-    # discouraged by the +MOVE+ extension and disallowed by +IMAP4rev2+.
-    #
-    # == Required capability
-    # Requires either +UIDPLUS+ [RFC4315[https://www.rfc-editor.org/rfc/rfc4315]]
-    # or +IMAP4rev2+ capability.
-    #
-    class UIDPlusData < Struct.new(:uidvalidity, :source_uids, :assigned_uids)
-      ##
-      # method: uidvalidity
-      # :call-seq: uidvalidity -> nonzero uint32
-      #
-      # The UIDVALIDITY of the destination mailbox.
-
-      ##
-      # method: source_uids
-      # :call-seq: source_uids -> nil or an array of nonzero uint32
-      #
-      # The UIDs of the copied or moved messages.
-      #
-      # Note:: Returns +nil+ for Net::IMAP#append.
-
-      ##
-      # method: assigned_uids
-      # :call-seq: assigned_uids -> an array of nonzero uint32
-      #
-      # The newly assigned UIDs of the copied, moved, or appended messages.
-      #
-      # Note:: This always returns an array, even when it contains only one UID.
-
-      ##
-      # :call-seq: uid_mapping -> nil or a hash
-      #
-      # Returns a hash mapping each source UID to the newly assigned destination
-      # UID.
-      #
-      # Note:: Returns +nil+ for Net::IMAP#append.
-      def uid_mapping
-        source_uids&.zip(assigned_uids)&.to_h
-      end
-    end
-
-    # This replaces the `Data.define` polyfill that's used by net-imap 0.5.
-    class Data_define__uidvalidity___assigned_uids_ # :no-doc:
-      attr_reader :uidvalidity, :assigned_uids
-
-      def self.[](...) new(...) end
-      def self.new(uidvalidity   = (args = false; nil),
-              assigned_uids = nil,
-              **kwargs)
-        if kwargs.empty?
-          super(uidvalidity: uidvalidity, assigned_uids: assigned_uids)
-        elsif !args
-          super
-        else
-          raise ArgumentError, "sent both positional and keyword args"
-        end
-      end
-
-      def ==(other)
-        self.class == other.class &&
-          self.uidvalidity   == other.uidvalidity &&
-          self.assigned_uids == other.assigned_uids
-      end
-
-      def eql?(other)
-        self.class.eql?(other.class) &&
-          self.uidvalidity.eql?(other.uidvalidity) &&
-          self.assigned_uids.eql?(other.assigned_uids)
-      end
-
-      def hash; [self.class, uidvalidity, assigned_uids].hash end
-
-      def initialize(uidvalidity:, assigned_uids:)
-        @uidvalidity   = uidvalidity
-        @assigned_uids = assigned_uids
-        freeze
-      end
-    end
-
-    # >>>
-    #   *NOTE:* <em>AppendUIDData will replace UIDPlusData for +APPENDUID+ in the
-    #   +0.6.0+ release.</em>  To use AppendUIDData before +0.6.0+, set
-    #   Config#parser_use_deprecated_uidplus_data to +false+.
-    #
-    # AppendUIDData represents the ResponseCode#data that accompanies the
-    # +APPENDUID+ {response code}[rdoc-ref:ResponseCode].
-    #
-    # A server that supports +UIDPLUS+ (or +IMAP4rev2+) should send
-    # AppendUIDData inside every TaggedResponse returned by the
-    # append[rdoc-ref:Net::IMAP#append] command---unless the target mailbox
-    # reports +UIDNOTSTICKY+.
-    #
-    # == Required capability
-    # Requires either +UIDPLUS+ [RFC4315[https://www.rfc-editor.org/rfc/rfc4315]]
-    # or +IMAP4rev2+ capability.
-    class AppendUIDData < Data_define__uidvalidity___assigned_uids_
-      def initialize(uidvalidity:, assigned_uids:)
-        uidvalidity   = Integer(uidvalidity)
-        assigned_uids = SequenceSet[assigned_uids]
-        NumValidator.ensure_nz_number(uidvalidity)
-        if assigned_uids.include_star?
-          raise DataFormatError, "uid-set cannot contain '*'"
-        end
-        super
-      end
-
-      ##
-      # attr_reader: uidvalidity
-      # :call-seq: uidvalidity -> nonzero uint32
-      #
-      # The UIDVALIDITY of the destination mailbox.
-
-      ##
-      # attr_reader: assigned_uids
-      #
-      # A SequenceSet with the newly assigned UIDs of the appended messages.
-
-      # Returns the number of messages that have been appended.
-      def size
-        assigned_uids.count_with_duplicates
-      end
-    end
-
-    # This replaces the `Data.define` polyfill that's used by net-imap 0.5.
-    class Data_define__uidvalidity___source_uids___assigned_uids_ # :no-doc:
-      attr_reader :uidvalidity, :source_uids, :assigned_uids
-
-      def self.[](...) new(...) end
-      def self.new(uidvalidity   = (args = false; nil),
-                   source_uids   = nil,
-                   assigned_uids = nil,
-                   **kwargs)
-        if kwargs.empty?
-          super(uidvalidity:   uidvalidity,
-                source_uids:   source_uids,
-                assigned_uids: assigned_uids)
-        elsif !args
-          super(**kwargs)
-        else
-          raise ArgumentError, "sent both positional and keyword args"
-        end
-      end
-
-      def initialize(uidvalidity:, source_uids:, assigned_uids:)
-        @uidvalidity   = uidvalidity
-        @source_uids   = source_uids
-        @assigned_uids = assigned_uids
-        freeze
-      end
-
-      def ==(other)
-        self.class == other.class &&
-          self.uidvalidity   == other.uidvalidity &&
-          self.source_uids   == other.source_uids
-        self.assigned_uids == other.assigned_uids
-      end
-
-      def eql?(other)
-        self.class.eql?(other.class) &&
-          self.uidvalidity.eql?(other.uidvalidity) &&
-          self.source_uids.eql?(other.source_uids)
-        self.assigned_uids.eql?(other.assigned_uids)
-      end
-
-      def hash; [self.class, uidvalidity, source_uids, assigned_uids].hash end
-    end
-
-    # >>>
-    #   *NOTE:* <em>CopyUIDData will replace UIDPlusData for +COPYUID+ in the
-    #   +0.6.0+ release.</em>  To use CopyUIDData before +0.6.0+, set
-    #   Config#parser_use_deprecated_uidplus_data to +false+.
-    #
-    # CopyUIDData represents the ResponseCode#data that accompanies the
-    # +COPYUID+ {response code}[rdoc-ref:ResponseCode].
-    #
-    # A server that supports +UIDPLUS+ (or +IMAP4rev2+) should send CopyUIDData
-    # in response to
-    # copy[rdoc-ref:Net::IMAP#copy], {uid_copy}[rdoc-ref:Net::IMAP#uid_copy],
-    # move[rdoc-ref:Net::IMAP#copy], and {uid_move}[rdoc-ref:Net::IMAP#uid_move]
-    # commands---unless the destination mailbox reports +UIDNOTSTICKY+.
-    #
-    # Note that copy[rdoc-ref:Net::IMAP#copy] and
-    # {uid_copy}[rdoc-ref:Net::IMAP#uid_copy] return CopyUIDData in their
-    # TaggedResponse.  But move[rdoc-ref:Net::IMAP#copy] and
-    # {uid_move}[rdoc-ref:Net::IMAP#uid_move] _should_ send CopyUIDData in an
-    # UntaggedResponse response before sending their TaggedResponse.  However
-    # some servers do send CopyUIDData in the TaggedResponse for +MOVE+
-    # commands---this complies with the older +UIDPLUS+ specification but is
-    # discouraged by the +MOVE+ extension and disallowed by +IMAP4rev2+.
-    #
-    # == Required capability
-    # Requires either +UIDPLUS+ [RFC4315[https://www.rfc-editor.org/rfc/rfc4315]]
-    # or +IMAP4rev2+ capability.
-    class CopyUIDData < Data_define__uidvalidity___source_uids___assigned_uids_
-      def initialize(uidvalidity:, source_uids:, assigned_uids:)
-        uidvalidity   = Integer(uidvalidity)
-        source_uids   = SequenceSet[source_uids]
-        assigned_uids = SequenceSet[assigned_uids]
-        NumValidator.ensure_nz_number(uidvalidity)
-        if source_uids.include_star? || assigned_uids.include_star?
-          raise DataFormatError, "uid-set cannot contain '*'"
-        elsif source_uids.count_with_duplicates != assigned_uids.count_with_duplicates
-          raise DataFormatError, "mismatched uid-set sizes for %s and %s" % [
-            source_uids, assigned_uids
-          ]
-        end
-        super
-      end
-
-      ##
-      # attr_reader: uidvalidity
-      #
-      # The +UIDVALIDITY+ of the destination mailbox (a nonzero unsigned 32 bit
-      # integer).
-
-      ##
-      # attr_reader: source_uids
-      #
-      # A SequenceSet with the original UIDs of the copied or moved messages.
-
-      ##
-      # attr_reader: assigned_uids
-      #
-      # A SequenceSet with the newly assigned UIDs of the copied or moved
-      # messages.
-
-      # Returns the number of messages that have been copied or moved.
-      # source_uids and the assigned_uids will both the same number of UIDs.
-      def size
-        assigned_uids.count_with_duplicates
-      end
-
-      # :call-seq:
-      #   assigned_uid_for(source_uid) -> uid
-      #   self[source_uid] -> uid
-      #
-      # Returns the UID in the destination mailbox for the message that was
-      # copied from +source_uid+ in the source mailbox.
-      #
-      # This is the reverse of #source_uid_for.
-      #
-      # Related: source_uid_for, each_uid_pair, uid_mapping
-      def assigned_uid_for(source_uid)
-        idx = source_uids.find_ordered_index(source_uid) and
-          assigned_uids.ordered_at(idx)
-      end
-      alias :[] :assigned_uid_for
-
-      # :call-seq:
-      #   source_uid_for(assigned_uid) -> uid
-      #
-      # Returns the UID in the source mailbox for the message that was copied to
-      # +assigned_uid+ in the source mailbox.
-      #
-      # This is the reverse of #assigned_uid_for.
-      #
-      # Related: assigned_uid_for, each_uid_pair, uid_mapping
-      def source_uid_for(assigned_uid)
-        idx = assigned_uids.find_ordered_index(assigned_uid) and
-          source_uids.ordered_at(idx)
-      end
-
-      # Yields a pair of UIDs for each copied message.  The first is the
-      # message's UID in the source mailbox and the second is the UID in the
-      # destination mailbox.
-      #
-      # Returns an enumerator when no block is given.
-      #
-      # Please note the warning on uid_mapping before calling methods like
-      # +to_h+ or +to_a+ on the returned enumerator.
-      #
-      # Related: uid_mapping, assigned_uid_for, source_uid_for
-      def each_uid_pair
-        return enum_for(__method__) unless block_given?
-        source_uids.each_ordered_number.lazy
-          .zip(assigned_uids.each_ordered_number.lazy) do
-            |source_uid, assigned_uid|
-            yield source_uid, assigned_uid
-          end
-      end
-      alias each_pair each_uid_pair
-      alias each      each_uid_pair
-
-      # :call-seq: uid_mapping -> hash
-      #
-      # Returns a hash mapping each source UID to the newly assigned destination
-      # UID.
-      #
-      # <em>*Warning:*</em> The hash that is created may consume _much_ more
-      # memory than the data used to create it.  When handling responses from an
-      # untrusted server, check #size before calling this method.
-      #
-      # Related: each_uid_pair, assigned_uid_for, source_uid_for
-      def uid_mapping
-        each_uid_pair.to_h
-      end
-
-    end
-
-  end
-end