net-imap 0.4.22 → 0.5.0

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