Parse UIDPLUS responses and use them in the relevant commands as return values

Author: hoffi

lib/net/imap.rb

@@ -443,6 +443,11 @@ def login(user, password)
     #
     # A Net::IMAP::NoResponseError is raised if the mailbox does not
     # exist or is for some reason non-selectable.
+    #
+    # If the server supports the UIDPLUS extension it may return an additional
+    # "NO" response with a "UIDNOTSTICKY" response code indicating that the
+    # mailstore does not support persistent UIDs:
+    # +@responses["NO"].last.code.name == "UIDNOTSTICKY"+
     def select(mailbox)
       synchronize do
         @responses.clear
@@ -752,14 +757,22 @@ def status(mailbox, attr)
     # A Net::IMAP::NoResponseError is raised if the mailbox does
     # not exist (it is not created automatically), or if the flags,
     # date_time, or message arguments contain errors.
+    #
+    # If the server supports the UIDPLUS extension it returns an array
+    # with the UIDVALIDITY and the assigned UID of the appended message.
     def append(mailbox, message, flags = nil, date_time = nil)
       args = []
       if flags
         args.push(flags)
       end
       args.push(date_time) if date_time
       args.push(Literal.new(message))
-      send_command("APPEND", mailbox, *args)
+      synchronize do
+        resp = send_command("APPEND", mailbox, *args)
+        if resp.data.code && resp.data.code.name == "APPENDUID"
+          return resp.data.code.data
+        end
+      end
     end
 
     # Sends a CHECK command to request a checkpoint of the currently
@@ -915,6 +928,10 @@ def uid_store(set, attr, flags)
     # of the specified destination +mailbox+. The +set+ parameter is
     # a number, an array of numbers, or a Range object. The number is
     # a message sequence number.
+    #
+    # If the server supports the UIDPLUS extension it returns an array with
+    # the UIDVALIDITY, the UID set of the source messages and the assigned
+    # UID set of the copied messages.
     def copy(set, mailbox)
       copy_internal("COPY", set, mailbox)
     end
@@ -930,6 +947,10 @@ def uid_copy(set, mailbox)
     # a message sequence number.
     #
     # The MOVE extension is described in [EXT-MOVE[https://tools.ietf.org/html/rfc6851]].
+    #
+    # If the server supports the UIDPLUS extension it returns an array with
+    # the UIDVALIDITY, the UID set of the source messages and the assigned
+    # UID set of the moved messages.
     def move(set, mailbox)
       copy_internal("MOVE", set, mailbox)
     end
@@ -1392,7 +1413,12 @@ def store_internal(cmd, set, attr, flags)
     end
 
     def copy_internal(cmd, set, mailbox)
-      send_command(cmd, MessageSet.new(set), mailbox)
+      synchronize do
+        resp = send_command(cmd, MessageSet.new(set), mailbox)
+        if resp.data.code && resp.data.code.name == "COPYUID"
+          return resp.data.code.data
+        end
+      end
     end
 
     def sort_internal(cmd, sort_keys, search_keys, charset)

lib/net/imap/response_parser.rb

@@ -1103,6 +1103,12 @@ def resp_text
       #                   "UIDNEXT" SP nz-number / "UIDVALIDITY" SP nz-number /
       #                   "UNSEEN" SP nz-number /
       #                   atom [SP 1*<any TEXT-CHAR except "]">]
+      #
+      # See https://datatracker.ietf.org/doc/html/rfc4315#section-6.4 for UIDPLUS extension
+      #
+      # resp-code-apnd  = "APPENDUID" SP nz-number SP append-uid
+      # resp-code-copy  = "COPYUID" SP nz-number SP uid-set SP uid-set
+      # resp-text-code  =/ resp-code-apnd / resp-code-copy / "UIDNOTSTICKY"
       def resp_text_code
         token = match(T_ATOM)
         name = token.value.upcase
@@ -1119,6 +1125,20 @@ def resp_text_code
         when /\A(?:UIDVALIDITY|UIDNEXT|UNSEEN)\z/n
           match(T_SPACE)
           result = ResponseCode.new(name, number)
+        when /\A(?:APPENDUID)\z/n
+          match(T_SPACE)
+          uidvalidity = number
+          match(T_SPACE)
+          append_uid = number
+          result = ResponseCode.new(name, [uidvalidity, append_uid])
+        when /\A(?:COPYUID)\z/n
+          match(T_SPACE)
+          uidvalidity = number
+          match(T_SPACE)
+          from_uid = set
+          match(T_SPACE)
+          to_uid = set
+          result = ResponseCode.new(name, [uidvalidity, from_uid, to_uid])
         else
           token = lookahead
           if token.symbol == T_SPACE
@@ -1321,6 +1341,17 @@ def number
         return token.value.to_i
       end
 
+      def set
+        token = match(T_ATOM)
+        token.value.split(',').flat_map do |element|
+          if element.include?(':')
+            Range.new(*element.split(':').map(&:to_i)).to_a
+          else
+            element.to_i
+          end
+        end
+      end
+
       def nil_atom
         match(T_NIL)
         return nil

test/net/imap/test_imap.rb

@@ -808,6 +808,62 @@ def test_uid_expunge
     end
   end
 
+  def test_uidplus_responses
+    server = create_tcp_server
+    port = server.addr[1]
+    requests = []
+    start_server do
+      sock = server.accept
+      begin
+        sock.print("* OK test server\r\n")
+        line = sock.gets
+        size = line.slice(/{(\d+)}\r\n/, 1).to_i
+        sock.print("+ Ready for literal data\r\n")
+        sock.read(size)
+        sock.gets
+        sock.print("RUBY0001 OK [APPENDUID 38505 3955] APPEND completed\r\n")
+        requests.push(sock.gets)
+        sock.print("RUBY0002 OK [COPYUID 38505 3955,3960:3962 3963:3966] " \
+                   "COPY completed\r\n")
+        sock.gets
+        sock.print("* NO [UIDNOTSTICKY] Non-persistent UIDs\r\n")
+        sock.print("RUBY0003 OK SELECT completed\r\n")
+        sock.gets
+        sock.print("* BYE terminating connection\r\n")
+        sock.print("RUBY0004 OK LOGOUT completed\r\n")
+      ensure
+        sock.close
+        server.close
+      end
+    end
+
+    begin
+      imap = Net::IMAP.new(server_addr, :port => port)
+      resp = imap.append("inbox", <<~EOF.gsub(/\n/, "\r\n"), [:Seen], Time.now)
+        Subject: hello
+        From: [email protected]
+        To: [email protected]
+
+        hello world
+      EOF
+      assert_equal(resp, [38505, 3955])
+      resp = imap.uid_copy([3955,3960..3962], 'trash')
+      assert_equal(requests.pop, "RUBY0002 UID COPY 3955,3960:3962 trash\r\n")
+      assert_equal(
+        resp,
+        [38505, [3955, 3960, 3961, 3962], [3963, 3964, 3965, 3966]]
+      )
+      imap.select('trash')
+      assert_equal(
+        imap.responses["NO"].last.code,
+        Net::IMAP::ResponseCode.new('UIDNOTSTICKY', nil)
+      )
+      imap.logout
+    ensure
+      imap.disconnect if imap
+    end
+  end
+
   private
 
   def imaps_test