net-imap 0.4.22 → 0.6.3

data/lib/net/imap/stringprep/nameprep.rb

@@ -4,7 +4,7 @@ module Net
   class IMAP
     module StringPrep
 
-      # Defined in RFC3491[https://tools.ietf.org/html/rfc3491], the +nameprep+
+      # Defined in RFC3491[https://www.rfc-editor.org/rfc/rfc3491], the +nameprep+
       # profile of "Stringprep" is:
       # >>>
       #   used by the IDNA protocol for preparing domain names; it is not

data/lib/net/imap/stringprep/trace.rb

@@ -4,11 +4,11 @@ module Net
   class IMAP
     module StringPrep
 
-      # Defined in RFC-4505[https://tools.ietf.org/html/rfc4505] §3, The +trace+
+      # Defined in RFC-4505[https://www.rfc-editor.org/rfc/rfc4505] §3, The +trace+
       # profile of \StringPrep is used by the +ANONYMOUS+ \SASL mechanism.
       module Trace
 
-        # Defined in RFC-4505[https://tools.ietf.org/html/rfc4505] §3.
+        # Defined in RFC-4505[https://www.rfc-editor.org/rfc/rfc4505] §3.
         STRINGPREP_PROFILE = "trace"
 
         # >>>
@@ -23,7 +23,7 @@ module Net
         #   No Unicode normalization is required by this profile.
         NORMALIZATION = nil
 
-        # From RFC-4505[https://tools.ietf.org/html/rfc4505] §3, The "trace"
+        # From RFC-4505[https://www.rfc-editor.org/rfc/rfc4505] §3, The "trace"
         # Profile of "Stringprep":
         # >>>
         #   Characters from the following tables of [StringPrep] are prohibited:
@@ -47,7 +47,7 @@ module Net
 
         module_function
 
-        # From RFC-4505[https://tools.ietf.org/html/rfc4505] §3, The "trace"
+        # From RFC-4505[https://www.rfc-editor.org/rfc/rfc4505] §3, The "trace"
         # Profile of "Stringprep":
         # >>>
         #   The character repertoire of this profile is Unicode 3.2 [Unicode].

data/lib/net/imap/uidplus_data.rb

@@ -3,107 +3,8 @@
 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
+    #   *NOTE:* <em>AppendUIDData replaced 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+.
     #
@@ -118,7 +19,7 @@ module Net
     # == Required capability
     # Requires either +UIDPLUS+ [RFC4315[https://www.rfc-editor.org/rfc/rfc4315]]
     # or +IMAP4rev2+ capability.
-    class AppendUIDData < Data_define__uidvalidity___assigned_uids_
+    class AppendUIDData < Data.define(:uidvalidity, :assigned_uids)
       def initialize(uidvalidity:, assigned_uids:)
         uidvalidity   = Integer(uidvalidity)
         assigned_uids = SequenceSet[assigned_uids]
@@ -146,52 +47,8 @@ module Net
       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
+    #   *NOTE:* <em>CopyUIDData replaced 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+.
     #
@@ -216,7 +73,7 @@ module Net
     # == 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_
+    class CopyUIDData < Data.define(:uidvalidity, :source_uids, :assigned_uids)
       def initialize(uidvalidity:, source_uids:, assigned_uids:)
         uidvalidity   = Integer(uidvalidity)
         source_uids   = SequenceSet[source_uids]

data/lib/net/imap/vanished_data.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Net
+  class IMAP < Protocol
+
+    # Net::IMAP::VanishedData represents the contents of a +VANISHED+ response,
+    # which is described by the
+    # {QRESYNC}[https://www.rfc-editor.org/rfc/rfc7162.html] extension.
+    # [{RFC7162 §3.2.10}[https://www.rfc-editor.org/rfc/rfc7162.html#section-3.2.10]].
+    #
+    # +VANISHED+ responses replace +EXPUNGE+ responses when either the
+    # {QRESYNC}[https://www.rfc-editor.org/rfc/rfc7162.html] or the
+    # {UIDONLY}[https://www.rfc-editor.org/rfc/rfc9586.html] extension has been
+    # enabled.
+    class VanishedData < Data.define(:uids, :earlier)
+
+      # Returns a new VanishedData object.
+      #
+      # * +uids+ will be converted by SequenceSet.[].
+      # * +earlier+ will be converted to +true+ or +false+
+      def initialize(uids:, earlier:)
+        uids    = SequenceSet[uids] unless uids.equal? SequenceSet.empty
+        earlier = !!earlier
+        super
+      end
+
+      ##
+      # :attr_reader: uids
+      #
+      # SequenceSet of UIDs that have been permanently removed from the mailbox.
+
+      ##
+      # :attr_reader: earlier
+      #
+      # +true+ when the response was caused by Net::IMAP#uid_fetch with
+      # <tt>vanished: true</tt> or Net::IMAP#select/Net::IMAP#examine with
+      # <tt>qresync: true</tt>.
+      #
+      # +false+ when the response is used to announce message removals within an
+      # already selected mailbox.
+
+      # rdoc doesn't handle attr aliases nicely. :(
+      alias earlier? earlier # :nodoc:
+      ##
+      # :attr_reader: earlier?
+      #
+      # Alias for #earlier.
+
+      # Returns an Array of all of the UIDs in #uids.
+      #
+      # See SequenceSet#numbers.
+      def to_a; uids.numbers end
+
+      # Yields each UID in #uids and returns +self+.  Returns an Enumerator when
+      # no block is given.
+      #
+      # See SequenceSet#each_number.
+      def each(&)
+        return to_enum unless block_given?
+        uids.each_number(&)
+        self
+      end
+    end
+  end
+end