✨ Add support for MAILBOXID response code

Author: nevans

lib/net/imap.rb

@@ -505,6 +505,8 @@ module Net
   # - See #enable for information about support for UTF-8 string encoding.
   #
   # ==== RFC8474: +OBJECTID+
+  # - Adds +MAILBOXID+ ResponseCode to #create tagged response.
+  # - Adds +MAILBOXID+ ResponseCode to #select and #examine untagged response.
   # - Updates #fetch and #uid_fetch with the +EMAILID+ and +THREADID+ items.
   #   See FetchData#emailid and FetchData#emailid.
   # >>>

lib/net/imap/response_data.rb

@@ -256,6 +256,10 @@ class ResponseText < Struct.new(:code, :text)
     # * +ALREADYEXISTS+
     # * +NONEXISTENT+
     #
+    # Other supported \IMAP extension response codes:
+    # * +OBJECTID+ {[RFC8474]}[https://www.rfc-editor.org/rfc/rfc8474.html#section-7]
+    #   * +MAILBOXID+, #data will be a string
+    #
     class ResponseCode < Struct.new(:name, :data)
       ##
       # method: name

lib/net/imap/response_parser.rb

@@ -1794,6 +1794,9 @@ def resp_text
       #   resp-text-code   =/ "HIGHESTMODSEQ" SP mod-sequence-value /
       #                       "NOMODSEQ" /
       #                       "MODIFIED" SP sequence-set
+      #
+      # RFC8474: OBJECTID
+      #   resp-text-code   =/ "MAILBOXID" SP "(" objectid ")"
       def resp_text_code
         name = resp_text_code__name
         data =
@@ -1813,6 +1816,7 @@ def resp_text_code
             "LIMIT", "OVERQUOTA", "ALREADYEXISTS", "NONEXISTENT", "CLOSED",
             "NOTSAVED", "UIDNOTSTICKY", "UNKNOWN-CTE", "HASCHILDREN"
           when "NOMODSEQ"           # CONDSTORE
+          when "MAILBOXID"          then SP!; parens__objectid     # RFC8474: OBJECTID
           else
             SP? and text_chars_except_rbra
           end

test/net/imap/fixtures/response_parser/rfc8474_objectid_responses.yml

@@ -1,5 +1,28 @@
 ---
 :tests:
+  rfc8474_example_4.1_MAILBOXID_response_to_CREATE:
+    :response: "3 OK [MAILBOXID (F2212ea87-6097-4256-9d51-71338625)] Completed\r\n"
+    :expected: !ruby/struct:Net::IMAP::TaggedResponse
+      tag: '3'
+      name: OK
+      data: !ruby/struct:Net::IMAP::ResponseText
+        code: !ruby/struct:Net::IMAP::ResponseCode
+          name: MAILBOXID
+          data: F2212ea87-6097-4256-9d51-71338625
+        text: Completed
+      raw_data: "3 OK [MAILBOXID (F2212ea87-6097-4256-9d51-71338625)] Completed\r\n"
+
+  rfc8474_example_4.2_MAILBOXID_untagged_response_to_SELECT:
+    :response: "* OK [MAILBOXID (F2212ea87-6097-4256-9d51-71338625)] Ok\r\n"
+    :expected: !ruby/struct:Net::IMAP::UntaggedResponse
+      name: OK
+      data: !ruby/struct:Net::IMAP::ResponseText
+        code: !ruby/struct:Net::IMAP::ResponseCode
+          name: MAILBOXID
+          data: F2212ea87-6097-4256-9d51-71338625
+        text: Ok
+      raw_data: "* OK [MAILBOXID (F2212ea87-6097-4256-9d51-71338625)] Ok\r\n"
+
   rfc8474_example_5.3_EMAILID_and_THREADID:
     :response: "* 3 FETCH (EMAILID (M5fdc09b49ea703) THREADID (T11863d02dd95b5))\r\n"
     :expected: !ruby/struct:Net::IMAP::UntaggedResponse