net-imap 0.5.1 → 0.5.3

data/lib/net/imap.rb

@@ -414,7 +414,7 @@ module Net
   # >>>
   #   <em>The following are folded into +IMAP4rev2+ but are currently
   #   unsupported or incompletely supported by</em> Net::IMAP<em>: RFC4466
-  #   extensions, +ESEARCH+, +SEARCHRES+, +LIST-EXTENDED+, +LIST-STATUS+,
+  #   extensions, +SEARCHRES+, +LIST-EXTENDED+, +LIST-STATUS+,
   #   +LITERAL-+, and +SPECIAL-USE+.</em>
   #
   # ==== RFC2087: +QUOTA+
@@ -466,6 +466,10 @@ module Net
   # - Updates #append with the +APPENDUID+ ResponseCode
   # - Updates #copy, #move with the +COPYUID+ ResponseCode
   #
+  # ==== RFC4731: +ESEARCH+
+  # Folded into IMAP4rev2[https://tools.ietf.org/html/rfc9051].
+  # - Updates #search, #uid_search with +return+ options and ESearchResult.
+  #
   # ==== RFC4959: +SASL-IR+
   # Folded into IMAP4rev2[https://tools.ietf.org/html/rfc9051].
   # - Updates #authenticate with the option to send an initial response.
@@ -719,7 +723,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.5.1"
+    VERSION = "0.5.3"
 
     # Aliases for supported capabilities, to be used with the #enable command.
     ENABLE_ALIASES = {
@@ -1123,7 +1127,7 @@ module Net
     #
     # See [ID[https://tools.ietf.org/html/rfc2971]] for field definitions.
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include +ID+
     # [RFC2971[https://tools.ietf.org/html/rfc2971]].
@@ -1205,7 +1209,7 @@ module Net
     #
     # Related: Net::IMAP.new, #login, #authenticate
     #
-    # ===== Capability
+    # ==== Capability
     # Clients should not call #starttls unless the server advertises the
     # +STARTTLS+ capability.
     #
@@ -1352,7 +1356,7 @@ module Net
     #
     # Related: #authenticate, #starttls
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # An IMAP client MUST NOT call #login when the server advertises the
     # +LOGINDISABLED+ capability.  By default, Net::IMAP will raise a
@@ -1393,7 +1397,7 @@ module Net
     #
     # Related: #examine
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # If [UIDPLUS[https://www.rfc-editor.org/rfc/rfc4315.html]] is supported,
     # the server may return an untagged "NO" response with a "UIDNOTSTICKY"
@@ -1511,7 +1515,7 @@ module Net
     #
     # Related: #lsub, MailboxList
     #
-    # ===== For example:
+    # ==== For example:
     #
     #   imap.create("foo/bar")
     #   imap.create("foo/baz")
@@ -1562,7 +1566,7 @@ module Net
     #
     # Related: #list, Namespaces, Namespace
     #
-    # ===== For example:
+    # ==== For example:
     #
     #    if capable?("NAMESPACE")
     #      namespaces = imap.namespace
@@ -1576,7 +1580,7 @@ module Net
     #      end
     #    end
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include +NAMESPACE+
     # [RFC2342[https://tools.ietf.org/html/rfc2342]].
@@ -1615,7 +1619,7 @@ module Net
     #
     # Related: #list, MailboxList
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include +XLIST+,
     # a deprecated Gmail extension (replaced by +SPECIAL-USE+).
@@ -1638,7 +1642,7 @@ module Net
     #
     # Related: #getquota, #setquota, MailboxQuotaRoot, MailboxQuota
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include +QUOTA+
     # [RFC2087[https://tools.ietf.org/html/rfc2087]].
@@ -1659,7 +1663,7 @@ module Net
     #
     # Related: #getquotaroot, #setquota, MailboxQuota
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include +QUOTA+
     # [RFC2087[https://tools.ietf.org/html/rfc2087]].
@@ -1677,7 +1681,7 @@ module Net
     #
     # Related: #getquota, #getquotaroot
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include +QUOTA+
     # [RFC2087[https://tools.ietf.org/html/rfc2087]].
@@ -1697,7 +1701,7 @@ module Net
     #
     # Related: #getacl
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include +ACL+
     # [RFC4314[https://tools.ietf.org/html/rfc4314]].
@@ -1715,7 +1719,7 @@ module Net
     #
     # Related: #setacl, MailboxACLItem
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include +ACL+
     # [RFC4314[https://tools.ietf.org/html/rfc4314]].
@@ -1752,7 +1756,7 @@ module Net
     # for +mailbox+ cannot be returned; for instance, because it
     # does not exist.
     #
-    # ===== Supported attributes
+    # ==== Supported attributes
     #
     # +MESSAGES+::    The number of messages in the mailbox.
     #
@@ -1783,12 +1787,12 @@ module Net
     # Unsupported attributes may be requested.  The attribute value will be
     # either an Integer or an ExtensionData object.
     #
-    # ===== For example:
+    # ==== For example:
     #
     #   p imap.status("inbox", ["MESSAGES", "RECENT"])
     #   #=> {"RECENT"=>0, "MESSAGES"=>44}
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # +SIZE+ requires the server's capabilities to include either +IMAP4rev2+ or
     # <tt>STATUS=SIZE</tt>
@@ -1828,7 +1832,7 @@ module Net
     # not exist (it is not created automatically), or if the flags,
     # date_time, or message arguments contain errors.
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # If +UIDPLUS+ [RFC4315[https://www.rfc-editor.org/rfc/rfc4315.html]] is
     # supported and the destination supports persistent UIDs, the server's
@@ -1877,7 +1881,7 @@ module Net
     #
     # Related: #close
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include +UNSELECT+
     # [RFC3691[https://tools.ietf.org/html/rfc3691]].
@@ -1885,110 +1889,243 @@ module Net
       send_command("UNSELECT")
     end
 
+    # call-seq:
+    #   expunge -> array of message sequence numbers
+    #   expunge -> VanishedData of UIDs
+    #
     # Sends an {EXPUNGE command [IMAP4rev1 §6.4.3]}[https://www.rfc-editor.org/rfc/rfc3501#section-6.4.3]
-    # Sends a EXPUNGE command to permanently remove from the currently
-    # selected mailbox all messages that have the \Deleted flag set.
+    # to permanently remove all messages with the +\Deleted+ flag from the
+    # currently selected mailbox.
+    #
+    # Returns either an array of expunged message <em>sequence numbers</em> or
+    # (when the appropriate capability is enabled) VanishedData of expunged
+    # UIDs.  Previously unhandled +EXPUNGE+ or +VANISHED+ responses are merged
+    # with the direct response to this command.  <tt>VANISHED (EARLIER)</tt>
+    # responses will _not_ be merged.
+    #
+    # When no messages have been expunged, an empty array is returned,
+    # regardless of which extensions are enabled.  In a future release, an empty
+    # VanishedData may be returned, based on the currently enabled extensions.
     #
     # Related: #uid_expunge
+    #
+    # ==== Capabilities
+    #
+    # When either QRESYNC[https://tools.ietf.org/html/rfc7162] or
+    # UIDONLY[https://tools.ietf.org/html/rfc9586] are enabled, #expunge
+    # returns VanishedData, which contains UIDs---<em>not message sequence
+    # numbers</em>.
     def expunge
-      synchronize do
-        send_command("EXPUNGE")
-        clear_responses("EXPUNGE")
-      end
+      expunge_internal("EXPUNGE")
     end
 
+    # call-seq:
+    #   uid_expunge{uid_set) -> array of message sequence numbers
+    #   uid_expunge{uid_set) -> VanishedData of UIDs
+    #
     # Sends a {UID EXPUNGE command [RFC4315 §2.1]}[https://www.rfc-editor.org/rfc/rfc4315#section-2.1]
     # {[IMAP4rev2 §6.4.9]}[https://www.rfc-editor.org/rfc/rfc9051#section-6.4.9]
     # to permanently remove all messages that have both the <tt>\\Deleted</tt>
     # flag set and a UID that is included in +uid_set+.
     #
+    # Returns the same result type as #expunge.
+    #
     # By using #uid_expunge instead of #expunge when resynchronizing with
     # the server, the client can ensure that it does not inadvertantly
     # remove any messages that have been marked as <tt>\\Deleted</tt> by other
     # clients between the time that the client was last connected and
     # the time the client resynchronizes.
     #
-    # *Note:*
-    # >>>
-    #        Although the command takes a set of UIDs for its argument, the
-    #        server still returns regular EXPUNGE responses, which contain
-    #        a <em>sequence number</em>. These will be deleted from
-    #        #responses and this method returns them as an array of
-    #        <em>sequence number</em> integers.
-    #
     # Related: #expunge
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
-    # The server's capabilities must include +UIDPLUS+
+    # The server's capabilities must include either +IMAP4rev2+ or +UIDPLUS+
     # [RFC4315[https://www.rfc-editor.org/rfc/rfc4315.html]].
+    #
+    # Otherwise, #uid_expunge is updated by extensions in the same way as
+    # #expunge.
     def uid_expunge(uid_set)
-      synchronize do
-        send_command("UID EXPUNGE", SequenceSet.new(uid_set))
-        clear_responses("EXPUNGE")
-      end
+      expunge_internal("UID EXPUNGE", SequenceSet.new(uid_set))
     end
 
     # :call-seq:
     #   search(criteria, charset = nil) -> result
+    #   search(criteria, charset: nil, return: nil) -> result
     #
     # Sends a {SEARCH command [IMAP4rev1 §6.4.4]}[https://www.rfc-editor.org/rfc/rfc3501#section-6.4.4]
     # to search the mailbox for messages that match the given search +criteria+,
-    # and returns a SearchResult.  SearchResult inherits from Array (for
-    # backward compatibility) but adds SearchResult#modseq when the +CONDSTORE+
-    # capability has been enabled.
+    # and returns either a SearchResult or an ESearchResult.  SearchResult
+    # inherits from Array (for backward compatibility) but adds
+    # SearchResult#modseq when the +CONDSTORE+ capability has been enabled.
+    # ESearchResult also implements {#to_a}[rdoc-ref:ESearchResult#to_a], for
+    # compatibility with SearchResult.
     #
     # +criteria+ is one or more search keys and their arguments, which may be
     # provided as an array or a string.
-    # See {"Search criteria"}[rdoc-ref:#search@Search+criteria], below.
-    #
-    # * When +criteria+ is an array, each member is a +SEARCH+ command argument:
-    #   * Any SequenceSet sends SequenceSet#valid_string.
-    #     These types are converted to SequenceSet for validation and encoding:
-    #     * +Set+
-    #     * +Range+
-    #     * <tt>-1</tt> and +:*+ -- both translate to <tt>*</tt>
-    #     * responds to +#to_sequence_set+
-    #     * +Array+, when each element is one of the above types, a positive
-    #       +Integer+, a sequence-set formatted +String+, or a deeply nested
-    #       +Array+ of these same types.
-    #   * Any +String+ is sent verbatim when it is a valid \IMAP atom,
-    #     and encoded as an \IMAP quoted or literal string otherwise.
-    #   * Any other nested +Array+ is encoded as a parenthesized list, to group
-    #     multiple search keys (e.g., for use with +OR+ and +NOT+).
-    #   * Any other +Integer+ (besides <tt>-1</tt>) will be sent as +#to_s+.
-    #   * +Date+ objects will be encoded as an \IMAP date (see ::encode_date).
-    #
-    # * When +criteria+ is a string, it will be sent directly to the server
-    #   <em>without any validation or encoding</em>.  *WARNING:* This is
-    #   vulnerable to injection attacks when external inputs are used.
+    # See {"Argument translation"}[rdoc-ref:#search@Argument+translation]
+    # and {"Search criteria"}[rdoc-ref:#search@Search+criteria], below.
+    #
+    # +return+ options control what kind of information is returned about
+    # messages matching the search +criteria+.  Specifying +return+ should force
+    # the server to return an ESearchResult instead of a SearchResult, but some
+    # servers disobey this requirement.  <em>Requires an extended search
+    # capability, such as +ESEARCH+ or +IMAP4rev2+.</em>
+    # See {"Argument translation"}[rdoc-ref:#search@Argument+translation]
+    # and {"Return options"}[rdoc-ref:#search@Return+options], below.
     #
     # +charset+ is the name of the {registered character
     # set}[https://www.iana.org/assignments/character-sets/character-sets.xhtml]
     # used by strings in the search +criteria+.  When +charset+ isn't specified,
     # either <tt>"US-ASCII"</tt> or <tt>"UTF-8"</tt> is assumed, depending on
-    # the server's capabilities.  +charset+ may be sent inside +criteria+
-    # instead of as a separate argument.
+    # the server's capabilities.
+    #
+    # _NOTE:_ Return options and charset may be sent as part of +criteria+.  Do
+    # not use the +return+ or +charset+ arguments when either return options or
+    # charset are embedded in +criteria+.
     #
     # Related: #uid_search
     #
-    # ===== For example:
+    # ==== For example:
     #
-    #   p imap.search(["SUBJECT", "hello", "NOT", "SEEN"])
+    #   imap.search(["SUBJECT", "hello", "NOT", "SEEN"])
     #   #=> [1, 6, 7, 8]
     #
-    # The following searches send the exact same command to the server:
-    #
-    #    # criteria array, charset arg
-    #    imap.search(["OR", "UNSEEN", %w(FLAGGED SUBJECT foo)], "UTF-8")
-    #    # criteria string, charset arg
-    #    imap.search("OR UNSEEN (FLAGGED SUBJECT foo)", "UTF-8")
-    #    # criteria array contains charset arg
-    #    imap.search([*%w[CHARSET UTF-8], "OR", "UNSEEN", %w(FLAGGED SUBJECT foo)])
-    #    # criteria string contains charset arg
-    #    imap.search("CHARSET UTF-8 OR UNSEEN (FLAGGED SUBJECT foo)")
-    #
-    # ===== Search keys
+    # The following assumes the server supports +ESEARCH+ and +CONDSTORE+:
+    #
+    #   result = imap.uid_search(["UID", 12345.., "MODSEQ", 620_162_338],
+    #                            return: %w(all count min max))
+    #   # => #<data Net::IMAP::ESearchResult tag="RUBY0123", uid=true,
+    #   #       data=[["ALL", Net::IMAP::SequenceSet["12346:12349,22222:22230"]],
+    #   #             ["COUNT", 13], ["MIN", 12346], ["MAX", 22230],
+    #   #             ["MODSEQ", 917162488]]>
+    #   result.to_a   # => [12346, 12347, 12348, 12349, 22222, 22223, 22224,
+    #                 #     22225, 22226, 22227, 22228, 22229, 22230]
+    #   result.uid?   # => true
+    #   result.count  # => 13
+    #   result.min    # => 12346
+    #   result.max    # => 22230
+    #   result.modseq # => 917162488
+    #
+    # Using +return+ options to limit the result to only min, max, and count:
+    #
+    #   result = imap.uid_search(["UID", 12345..,], return: %w(count min max))
+    #   # => #<data Net::IMAP::ESearchResult tag="RUBY0124", uid=true,
+    #   #       data=[["COUNT", 13], ["MIN", 12346], ["MAX", 22230]]>
+    #   result.to_a   # => []
+    #   result.count  # => 13
+    #   result.min    # => 12346
+    #   result.max    # => 22230
+    #
+    # Return options and charset may be sent as keyword args or embedded in the
+    # +criteria+ arg, but they must be in the correct order: <tt>"RETURN (...)
+    # CHARSET ... criteria..."</tt>.  The following searches
+    # send the exact same command to the server:
+    #
+    #    # Return options and charset as keyword arguments (preferred)
+    #    imap.search(%w(OR UNSEEN FLAGGED), return: %w(MIN MAX), charset: "UTF-8")
+    #    # Embedding return and charset in the criteria array
+    #    imap.search(["RETURN", %w(MIN MAX), "CHARSET", "UTF-8", *%w(OR UNSEEN FLAGGED)])
+    #    # Embedding return and charset in the criteria string
+    #    imap.search("RETURN (MIN MAX) CHARSET UTF-8 OR UNSEEN FLAGGED")
+    #
+    # Sending charset as the second positional argument is supported for
+    # backward compatibility.  Future versions may print a deprecation warning:
+    #    imap.search(%w(OR UNSEEN FLAGGED), "UTF-8", return: %w(MIN MAX))
+    #
+    # ==== Argument translation
+    #
+    # [+return+ options]
+    #   Must be an Array.  Return option names may be either strings or symbols.
+    #   +Range+ elements which begin and end with negative integers are encoded
+    #   for use with +PARTIAL+--any other ranges are converted to SequenceSet.
+    #   Unlike +criteria+, other return option arguments are not automatically
+    #   converted to SequenceSet.
+    #
+    # [When +criteria+ is an Array]
+    #   When the array begins with <tt>"RETURN"</tt> (case insensitive), the
+    #   second array element is translated like the +return+ parameter (as
+    #   described above).
+    #
+    #   Every other member is a +SEARCH+ command argument:
+    #   [SequenceSet]
+    #     Encoded as an \IMAP +sequence-set+ with SequenceSet#valid_string.
+    #   [Set, Range, <tt>-1</tt>, +:*+, responds to +#to_sequence_set+]
+    #     Converted to SequenceSet for validation and encoding.
+    #   [nested sequence-set +Array+]
+    #     When every element in a nested array is one of the above types, a
+    #     positive +Integer+, a sequence-set formatted +String+, or a deeply
+    #     nested +Array+ of these same types, the array will be converted to
+    #     SequenceSet for validation and encoding.
+    #   [Any other nested +Array+]
+    #     Otherwise, a nested array is encoded as a parenthesized list, to
+    #     combine multiple search keys (e.g., for use with +OR+ and +NOT+).
+    #   [+String+]
+    #     Sent verbatim when it is a valid \IMAP +atom+, and encoded as an \IMAP
+    #     +quoted+ or +literal+ string otherwise.  Every standard search key
+    #     name is a valid \IMAP +atom+ and every standard search key string
+    #     argument is an +astring+ which may be encoded as +atom+, +quoted+, or
+    #     +literal+.
+    #
+    #     *Note:* <tt>*</tt> is not a valid \IMAP +atom+ character.  Any string
+    #     containing <tt>*</tt> will be encoded as a +quoted+ string, _not_ a
+    #     +sequence-set+.
+    #   [+Integer+ (except for <tt>-1</tt>)]
+    #     Encoded using +#to_s+.
+    #   [+Date+]
+    #     Encoded as an \IMAP date (see ::encode_date).
+    #
+    # [When +criteria+ is a String]
+    #   +criteria+ will be sent directly to the server <em>without any
+    #   validation or encoding</em>.
+    #
+    #   <em>*WARNING:* This is vulnerable to injection attacks when external
+    #   inputs are used.</em>
+    #
+    # ==== Return options
+    #
+    # For full definitions of the standard return options and return data, see
+    # the relevant RFCs.
+    #
+    # ===== +ESEARCH+ or +IMAP4rev2+
+    #
+    # The following return options require either +ESEARCH+ or +IMAP4rev2+.
+    # See [{RFC4731 §3.1}[https://rfc-editor.org/rfc/rfc4731#section-3.1]] or
+    # [{IMAP4rev2 §6.4.4}[https://www.rfc-editor.org/rfc/rfc9051.html#section-6.4.4]].
+    #
+    # [+ALL+]
+    #    Returns ESearchResult#all with a SequenceSet of all matching sequence
+    #    numbers or UIDs.  This is the default, when return options are empty.
+    #
+    #    For compatibility with SearchResult, ESearchResult#to_a returns an
+    #    Array of message sequence numbers or UIDs.
+    # [+COUNT+]
+    #    Returns ESearchResult#count with the number of matching messages.
+    # [+MAX+]
+    #    Returns ESearchResult#max with the highest matching sequence number or
+    #    UID.
+    # [+MIN+]
+    #    Returns ESearchResult#min with the lowest matching sequence number or
+    #    UID.
+    #
+    # ===== +CONDSTORE+
+    #
+    # ESearchResult#modseq return data does not have a corresponding return
+    # option.  Instead, it is returned if the +MODSEQ+ search key is used or
+    # when the +CONDSTORE+ extension is enabled for the selected mailbox.
+    # See [{RFC4731 §3.2}[https://www.rfc-editor.org/rfc/rfc4731#section-3.2]]
+    # or [{RFC7162 §2.1.5}[https://www.rfc-editor.org/rfc/rfc7162#section-3.1.5]].
+    #
+    # ===== +RFC4466+ compatible extensions
+    #
+    # {RFC4466 §2.6}[https://www.rfc-editor.org/rfc/rfc4466.html#section-2.6]
+    # defines standard syntax for search extensions.  Net::IMAP allows sending
+    # unknown search return options and will parse unknown search extensions'
+    # return values into ExtensionData.  Please note that this is an
+    # intentionally _unstable_ API.  Future releases may return different
+    # (incompatible) objects, <em>without deprecation or warning</em>.
+    #
+    # ==== Search keys
     #
     # For full definitions of the standard search +criteria+,
     # see [{IMAP4rev1 §6.4.4}[https://www.rfc-editor.org/rfc/rfc3501.html#section-6.4.4]],
@@ -2003,23 +2140,21 @@ module Net
     # arguments.  The number and type of arguments is specific to each search
     # key.
     #
-    # +ALL+::
-    #   Matches every message in the mailbox.
+    # ===== Search keys that match all messages
     #
-    # (_search-key_ _search-key_...)::
-    #   Combines one or more _search-key_ arguments to match
-    #   messages which match all contained search keys.  Useful for +OR+, +NOT+,
-    #   and other search keys with _search-key_ arguments.
+    # [+ALL+]
+    #   The default initial key.  Matches every message in the mailbox.
     #
-    #   _Note:_ this search key has no label.
+    # [+SAVEDATESUPPORTED+]
+    #   Matches every message in the mailbox when the mailbox supports the save
+    #   date attribute.  Otherwise, it matches no messages.
     #
-    # +OR+ _search-key_ _search-key_::
-    #   Matches messages which match either _search-key_ argument.
+    #   <em>Requires +SAVEDATE+ capability</em>.
+    #   {[RFC8514]}[https://www.rfc-editor.org/rfc/rfc8514.html#section-4.3]
     #
-    # +NOT+ _search-key_::
-    #   Matches messages which do not match _search-key_.
+    # ===== Sequence set search keys
     #
-    # _sequence-set_::
+    # [_sequence-set_]
     #   Matches messages with message sequence numbers in _sequence-set_.
     #
     #   _Note:_ this search key has no label.
@@ -2027,121 +2162,139 @@ module Net
     #   <em>+UIDONLY+ must *not* be enabled.</em>
     #   {[RFC9586]}[https://www.rfc-editor.org/rfc/rfc9586.html]
     #
-    # +UID+ _sequence-set_::
+    # [+UID+ _sequence-set_]
     #   Matches messages with a UID in _sequence-set_.
     #
-    # +ANSWERED+::
-    # +UNANSWERED+::
+    # ===== Compound search keys
+    #
+    # [(_search-key_ _search-key_...)]
+    #   Combines one or more _search-key_ arguments to match
+    #   messages which match all contained search keys.  Useful for +OR+, +NOT+,
+    #   and other search keys with _search-key_ arguments.
+    #
+    #   _Note:_ this search key has no label.
+    #
+    # [+OR+ _search-key_ _search-key_]
+    #   Matches messages which match either _search-key_ argument.
+    #
+    # [+NOT+ _search-key_]
+    #   Matches messages which do not match _search-key_.
+    #
+    # [+FUZZY+ _search-key_]
+    #   Uses fuzzy matching for the specified search key.
+    #
+    #   <em>Requires <tt>SEARCH=FUZZY</tt> capability.</em>
+    #   {[RFC6203]}[https://www.rfc-editor.org/rfc/rfc6203.html#section-6].
+    #
+    # ===== Flags search keys
+    #
+    # [+ANSWERED+, +UNANSWERED+]
     #   Matches messages with or without the <tt>\\Answered</tt> flag.
-    # +DELETED+::
-    # +UNDELETED+::
+    # [+DELETED+, +UNDELETED+]
     #   Matches messages with or without the <tt>\\Deleted</tt> flag.
-    # +DRAFT+::
-    # +UNDRAFT+::
+    # [+DRAFT+, +UNDRAFT+]
     #   Matches messages with or without the <tt>\\Draft</tt> flag.
-    # +FLAGGED+::
-    # +UNFLAGGED+::
+    # [+FLAGGED+, +UNFLAGGED+]
     #   Matches messages with or without the <tt>\\Flagged</tt> flag.
-    # +SEEN+::
-    # +UNSEEN+::
+    # [+SEEN+, +UNSEEN+]
     #   Matches messages with or without the <tt>\\Seen</tt> flag.
-    #
-    # +KEYWORD+ _keyword_::
-    # +UNKEYWORD+ _keyword_::
+    # [+KEYWORD+ _keyword_, +UNKEYWORD+ _keyword_]
     #   Matches messages with or without the specified _keyword_.
     #
-    # +BCC+ _substring_::
-    #   Matches when _substring_ is in the envelope's BCC field.
-    # +CC+ _substring_::
-    #   Matches when _substring_ is in the envelope's CC field.
-    # +FROM+ _substring_::
-    #   Matches when _substring_ is in the envelope's FROM field.
-    # +SUBJECT+ _substring_::
-    #   Matches when _substring_ is in the envelope's SUBJECT field.
-    # +TO+ _substring_::
-    #   Matches when _substring_ is in the envelope's TO field.
-    #
-    # +HEADER+ _field_ _substring_::
+    # [+RECENT+, +UNRECENT+]
+    #   Matches messages with or without the <tt>\\Recent</tt> flag.
+    #
+    #   *NOTE:* The <tt>\\Recent</tt> flag has been removed from +IMAP4rev2+.
+    # [+NEW+]
+    #   Equivalent to <tt>(RECENT UNSEEN)</tt>.
+    #
+    #   *NOTE:* The <tt>\\Recent</tt> flag has been removed from +IMAP4rev2+.
+    #
+    # ===== Header field substring search keys
+    #
+    # [+BCC+ _substring_]
+    #   Matches when _substring_ is in the envelope's +BCC+ field.
+    # [+CC+ _substring_]
+    #   Matches when _substring_ is in the envelope's +CC+ field.
+    # [+FROM+ _substring_]
+    #   Matches when _substring_ is in the envelope's +FROM+ field.
+    # [+SUBJECT+ _substring_]
+    #   Matches when _substring_ is in the envelope's +SUBJECT+ field.
+    # [+TO+ _substring_]
+    #   Matches when _substring_ is in the envelope's +TO+ field.
+    #
+    # [+HEADER+ _field_ _substring_]
     #   Matches when _substring_ is in the specified header _field_.
     #
-    # +BODY+ _string_::
+    # ===== Body text search keys
+    # [+BODY+ _string_]
     #   Matches when _string_ is in the body of the message.
     #   Does not match on header fields.
     #
     #   The server _may_ use flexible matching, rather than simple substring
     #   matches.  For example, this may use stemming or match only full words.
     #
-    # +TEXT+ _string_::
+    # [+TEXT+ _string_]
     #   Matches when _string_ is in the header or body of the message.
     #
     #   The server _may_ use flexible matching, rather than simple substring
     #   matches.  For example, this may use stemming or match only full words.
     #
-    # +BEFORE+ _date_::
-    # +ON+ _date_::
-    # +SINCE+ _date_::
-    #   Matches when the +INTERNALDATE+ is earlier than, on, or later than
-    #   _date_.
+    # ===== Date/Time search keys
     #
-    # +SENTBEFORE+ _date_::
-    # +SENTON+ _date_::
-    # +SENTSINCE+ _date_::
+    # [+SENTBEFORE+ _date_]
+    # [+SENTON+ _date_]
+    # [+SENTSINCE+ _date_]
     #   Matches when the +Date+ header is earlier than, on, or later than _date_.
     #
-    # +SMALLER+ _bytes_::
-    # +LARGER+ _bytes_::
-    #   Matches when +RFC822.SIZE+ is smaller/larger than _bytes_.
-    #
-    # ====== Removed from +IMAP4rev2+
-    #
-    # The <tt>\\Recent</tt> flag has been removed from +IMAP4rev2+.  So these
-    # search keys require the +IMAP4rev1+ capability.
+    # [+BEFORE+ _date_]
+    # [+ON+ _date_]
+    # [+SINCE+ _date_]
+    #   Matches when the +INTERNALDATE+ is earlier than, on, or later than
+    #   _date_.
     #
-    # +RECENT+::
-    # +UNRECENT+::
-    #   Matches messages with or without the <tt>\\Recent</tt> flag.
+    # [+OLDER+ _interval_]
+    # [+YOUNGER+ _interval_]
+    #   Matches when the +INTERNALDATE+ is more/less than _interval_ seconds ago.
     #
-    # +NEW+::
-    #   Equivalent to <tt>(RECENT UNSEEN)</tt>.
+    #   <em>Requires +WITHIN+ capability</em>.
+    #   {[RFC5032]}[https://www.rfc-editor.org/rfc/rfc5032.html]
     #
-    # ====== Extension search keys
+    # [+SAVEDBEFORE+ _date_]
+    # [+SAVEDON+ _date_]
+    # [+SAVEDSINCE+ _date_]
+    #   Matches when the save date is earlier than, on, or later than _date_.
     #
-    # The search keys described below are defined by standard \IMAP extensions.
+    #   <em>Requires +SAVEDATE+ capability.</em>
+    #   {[RFC8514]}[https://www.rfc-editor.org/rfc/rfc8514.html#section-4.3]
     #
-    # +OLDER+ _interval_::
-    # +YOUNGER+ _interval_::
-    #   Matches when +INTERNALDATE+ is more/less than _interval_ seconds ago.
+    # ===== Other message attribute search keys
     #
-    #   <em>Requires the +WITHIN+ capability</em>.
-    #   {[RFC5032]}[https://www.rfc-editor.org/rfc/rfc5032.html]
+    # [+SMALLER+ _bytes_]
+    # [+LARGER+ _bytes_]
+    #   Matches when +RFC822.SIZE+ is smaller or larger than _bytes_.
     #
-    # +ANNOTATION+ _entry_ _attr_ _value_::
+    # [+ANNOTATION+ _entry_ _attr_ _value_]
     #   Matches messages that have annotations with entries matching _entry_,
     #   attributes matching _attr_, and _value_ in the attribute's values.
     #
-    #   <em>Requires the +ANNOTATE-EXPERIMENT-1+ capability</em>.
+    #   <em>Requires +ANNOTATE-EXPERIMENT-1+ capability</em>.
     #   {[RFC5257]}[https://www.rfc-editor.org/rfc/rfc5257.html].
     #
-    # +FILTER+ _filter_::
+    # [+FILTER+ _filter_]
     #   References a _filter_ that is stored on the server and matches all
     #   messages which would be matched by that filter's search criteria.
     #
-    #   <em>Requires the +FILTERS+ capability</em>.
+    #   <em>Requires +FILTERS+ capability</em>.
     #   {[RFC5466]}[https://www.rfc-editor.org/rfc/rfc5466.html#section-3.1]
     #
-    # +FUZZY+ _search-key_::
-    #   Uses fuzzy matching for the specified search key.
-    #
-    #   <em>Requires the <tt>SEARCH=FUZZY</tt> capability.</em>
-    #   {[RFC6203]}[https://www.rfc-editor.org/rfc/rfc6203.html#section-6].
-    #
-    # +MODSEQ+ _modseq_::
+    # [+MODSEQ+ _modseq_]
     #   Matches when +MODSEQ+ is greater than or equal to _modseq_.
     #
-    #   <em>Requires the +CONDSTORE+ capability</em>.
+    #   <em>Requires +CONDSTORE+ capability</em>.
     #   {[RFC7162]}[https://www.rfc-editor.org/rfc/rfc7162.html#section-3.1.5].
     #
-    # +MODSEQ+ _entry_ _entry-type_ _modseq_::
+    # [+MODSEQ+ _entry_ _entry-type_ _modseq_]
     #   Matches when a specific metadata _entry_ has been updated since
     #   _modseq_.
     #
@@ -2150,33 +2303,25 @@ module Net
     #   <tt>\\</tt> prefix.  _entry-type_ can be one of <tt>"shared"</tt>,
     #   <tt>"priv"</tt> (private), or <tt>"all"</tt>.
     #
-    #   <em>Requires the +CONDSTORE+ capability</em>.
+    #   <em>Requires +CONDSTORE+ capability</em>.
     #   {[RFC7162]}[https://www.rfc-editor.org/rfc/rfc7162.html#section-3.1.5].
     #
-    # +EMAILID+ _objectid_::
-    # +THREADID+ _objectid_::
+    # [+EMAILID+ _objectid_]
+    # [+THREADID+ _objectid_]
     #   Matches when +EMAILID+/+THREADID+ is equal to _objectid_
     #   (substring matches are not supported).
     #
-    #   <em>Requires the +OBJECTID+ capability</em>.
+    #   <em>Requires +OBJECTID+ capability</em>.
     #   {[RFC8474]}[https://www.rfc-editor.org/rfc/rfc8474.html#section-6]
     #
-    # +SAVEDATESUPPORTED+::
-    #   Matches every message in the mailbox when the mailbox supports the save
-    #   date attribute.  Otherwise, it matches no messages.
-    #
-    #   <em>Requires the +SAVEDATE+ capability</em>.
-    #   {[RFC8514]}[https://www.rfc-editor.org/rfc/rfc8514.html#section-4.3]
-    #
-    # +SAVEDBEFORE+ _date_::
-    # +SAVEDON+ _date_::
-    # +SAVEDSINCE+ _date_::
-    #   Matches when the save date is earlier than, on, or later than _date_.
+    # ==== Capabilities
     #
-    #   <em>Requires the +SAVEDATE+ capability.</em>
-    #   {[RFC8514]}[https://www.rfc-editor.org/rfc/rfc8514.html#section-4.3]
+    # Return options should only be specified when the server supports
+    # +IMAP4rev2+ or an extension that allows them, such as +ESEARCH+
+    # [RFC4731[https://rfc-editor.org/rfc/rfc4731#section-3.1]].
     #
-    # ===== Capabilities
+    # When +IMAP4rev2+ is enabled, or when the server supports +IMAP4rev2+ but
+    # not +IMAP4rev1+, ESearchResult is always returned instead of SearchResult.
     #
     # If CONDSTORE[https://www.rfc-editor.org/rfc/rfc7162.html] is supported
     # and enabled for the selected mailbox, a non-empty SearchResult will
@@ -2191,6 +2336,7 @@ module Net
 
     # :call-seq:
     #   uid_search(criteria, charset = nil) -> result
+    #   uid_search(criteria, charset: nil, return: nil) -> result
     #
     # Sends a {UID SEARCH command [IMAP4rev1 §6.4.8]}[https://www.rfc-editor.org/rfc/rfc3501#section-6.4.8]
     # to search the mailbox for messages that match the given searching
@@ -2230,7 +2376,7 @@ module Net
     #
     # Related: #uid_search, FetchData
     #
-    # ===== For example:
+    # ==== For example:
     #
     #   p imap.fetch(6..8, "UID")
     #   #=> [#<Net::IMAP::FetchData seqno=6, attr={"UID"=>98}>, \\
@@ -2248,7 +2394,7 @@ module Net
     #   p data.attr["UID"]
     #   #=> 98
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # Many extensions define new message +attr+ names.  See FetchData for a list
     # of supported extension fields.
@@ -2277,7 +2423,7 @@ module Net
     #
     # Related: #fetch, FetchData
     #
-    # ===== Capabilities
+    # ==== Capabilities
     # Same as #fetch.
     def uid_fetch(set, attr, mod = nil, changedsince: nil)
       fetch_internal("UID FETCH", set, attr, mod, changedsince: changedsince)
@@ -2311,14 +2457,14 @@ module Net
     #
     # Related: #uid_store
     #
-    # ===== For example:
+    # ==== For example:
     #
     #   p imap.store(6..8, "+FLAGS", [:Deleted])
     #   #=> [#<Net::IMAP::FetchData seqno=6, attr={"FLAGS"=>[:Seen, :Deleted]}>,
     #        #<Net::IMAP::FetchData seqno=7, attr={"FLAGS"=>[:Seen, :Deleted]}>,
     #        #<Net::IMAP::FetchData seqno=8, attr={"FLAGS"=>[:Seen, :Deleted]}>]
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # Extensions may define new data items to be used with #store.
     #
@@ -2342,7 +2488,7 @@ module Net
     #
     # Related: #store
     #
-    # ===== Capabilities
+    # ==== Capabilities
     # Same as #store.
     def uid_store(set, attr, flags, unchangedsince: nil)
       store_internal("UID STORE", set, attr, flags, unchangedsince: unchangedsince)
@@ -2355,7 +2501,7 @@ module Net
     #
     # Related: #uid_copy
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # If +UIDPLUS+ [RFC4315[https://www.rfc-editor.org/rfc/rfc4315.html]] is
     # supported, the server's response should include a +COPYUID+ response code
@@ -2372,7 +2518,7 @@ module Net
     #
     # Similar to #copy, but +set+ contains unique identifiers.
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # +UIDPLUS+ affects #uid_copy the same way it affects #copy.
     def uid_copy(set, mailbox)
@@ -2387,7 +2533,7 @@ module Net
     #
     # Related: #uid_move
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include +MOVE+
     # [RFC6851[https://tools.ietf.org/html/rfc6851]].
@@ -2411,7 +2557,7 @@ module Net
     #
     # Related: #move
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # Same as #move: The server's capabilities must include +MOVE+
     # [RFC6851[https://tools.ietf.org/html/rfc6851]].  +UIDPLUS+ also affects
@@ -2431,14 +2577,14 @@ module Net
     #
     # Related: #uid_sort, #search, #uid_search, #thread, #uid_thread
     #
-    # ===== For example:
+    # ==== For example:
     #
     #   p imap.sort(["FROM"], ["ALL"], "US-ASCII")
     #   #=> [1, 2, 3, 5, 6, 7, 8, 4, 9]
     #   p imap.sort(["DATE"], ["SUBJECT", "hello"], "US-ASCII")
     #   #=> [6, 7, 8, 1]
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include +SORT+
     # [RFC5256[https://tools.ietf.org/html/rfc5256]].
@@ -2453,7 +2599,7 @@ module Net
     #
     # Related: #sort, #search, #uid_search, #thread, #uid_thread
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include +SORT+
     # [RFC5256[https://tools.ietf.org/html/rfc5256]].
@@ -2478,7 +2624,7 @@ module Net
     #
     # Related: #uid_thread, #search, #uid_search, #sort, #uid_sort
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include +THREAD+
     # [RFC5256[https://tools.ietf.org/html/rfc5256]].
@@ -2492,7 +2638,7 @@ module Net
     #
     # Related: #thread, #search, #uid_search, #sort, #uid_sort
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include +THREAD+
     # [RFC5256[https://tools.ietf.org/html/rfc5256]].
@@ -2511,7 +2657,7 @@ module Net
     #
     # Related: #capable?, #capabilities, #capability
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include
     # +ENABLE+ [RFC5161[https://tools.ietf.org/html/rfc5161]]
@@ -2613,7 +2759,7 @@ module Net
     #
     # Related: #idle_done, #noop, #check
     #
-    # ===== Capabilities
+    # ==== Capabilities
     #
     # The server's capabilities must include +IDLE+
     # [RFC2177[https://tools.ietf.org/html/rfc2177]].
@@ -2730,7 +2876,7 @@ module Net
     #
     # Related: #extract_responses, #clear_responses, #response_handlers, #greeting
     #
-    # ===== Thread safety
+    # ==== Thread safety
     # >>>
     #   *Note:* Access to the responses hash is synchronized for thread-safety.
     #   The receiver thread and response_handlers cannot process new responses
@@ -2744,7 +2890,7 @@ module Net
     #   thread, but will not modify any responses after adding them to the
     #   responses hash.
     #
-    # ===== Clearing responses
+    # ==== Clearing responses
     #
     # Previously unhandled responses are automatically cleared before entering a
     # mailbox with #select or #examine.  Long-lived connections can receive many
@@ -2753,7 +2899,7 @@ module Net
     # the block, or remove responses with #extract_responses, #clear_responses,
     # or #add_response_handler.
     #
-    # ===== Missing responses
+    # ==== Missing responses
     #
     # Only non-+nil+ data is stored.  Many important response codes have no data
     # of their own, but are used as "tags" on the ResponseText object they are
@@ -3131,12 +3277,108 @@ module Net
       end
     end
 
-    def search_internal(cmd, keys, charset = nil)
-      keys = normalize_searching_criteria(keys)
-      args = charset ? ["CHARSET", charset, *keys] : keys
+    def expunge_internal(...)
       synchronize do
-        send_command(cmd, *args)
-        clear_responses("SEARCH").last || []
+        send_command(...)
+        expunged_array = clear_responses("EXPUNGE")
+        vanished_array = extract_responses("VANISHED") { !_1.earlier? }
+        if vanished_array.empty?
+          expunged_array
+        elsif vanished_array.length == 1
+          vanished_array.first
+        else
+          merged_uids = SequenceSet[*vanished_array.map(&:uids)]
+          VanishedData[uids: merged_uids, earlier: false]
+        end
+      end
+    end
+
+    RETURN_WHOLE = /\ARETURN\z/i
+    RETURN_START = /\ARETURN\b/i
+    private_constant :RETURN_WHOLE, :RETURN_START
+
+    def search_args(keys, charset_arg = nil, return: nil, charset: nil)
+      {return:} => {return: return_kw}
+      case [return_kw, keys]
+      in [nil, Array[RETURN_WHOLE, return_opts, *keys]]
+        return_opts = convert_return_opts(return_opts)
+        esearch = true
+      in [nil => return_opts, RETURN_START]
+        esearch = true
+      in [nil => return_opts, keys]
+        esearch = false
+      in [_, Array[RETURN_WHOLE, _, *] | RETURN_START]
+        raise ArgumentError, "conflicting return options"
+      in [_, Array[RETURN_WHOLE, _, *]] # workaround for https://bugs.ruby-lang.org/issues/20956
+        raise ArgumentError, "conflicting return options"
+      in [_, RETURN_START]              # workaround for https://bugs.ruby-lang.org/issues/20956
+        raise ArgumentError, "conflicting return options"
+      in [return_opts, keys]
+        return_opts = convert_return_opts(return_opts)
+        esearch = true
+      end
+      if charset && charset_arg
+        raise ArgumentError, "multiple charset arguments"
+      end
+      charset ||= charset_arg
+      # NOTE: not handling combined RETURN and CHARSET for raw strings
+      if charset && keys in /\ACHARSET\b/i | Array[/\ACHARSET\z/i, *]
+        raise ArgumentError, "multiple charset arguments"
+      end
+      args = normalize_searching_criteria(keys)
+      args.prepend("CHARSET", charset)     if charset
+      args.prepend("RETURN",  return_opts) if return_opts
+      return args, esearch
+    end
+
+    def convert_return_opts(unconverted)
+      return_opts = Array.try_convert(unconverted) or
+        raise TypeError, "expected return options to be Array, got %s" % [
+          unconverted.class
+        ]
+      return_opts.map {|opt|
+        case opt
+        when Symbol then opt.to_s
+        when Range  then partial_range_last_or_seqset(opt)
+        else             opt
+        end
+      }
+    end
+
+    def partial_range_last_or_seqset(range)
+      case [range.begin, range.end]
+      in [Integer => first, Integer => last] if first.negative? && last.negative?
+        # partial-range-last [RFC9394]
+        first <= last or raise DataFormatError, "empty range: %p" % [range]
+        "#{first}:#{last}"
+      else
+        SequenceSet[range]
+      end
+    end
+
+    def search_internal(cmd, ...)
+      args, esearch = search_args(...)
+      synchronize do
+        tagged = send_command(cmd, *args)
+        tag    = tagged.tag
+        # Only the last ESEARCH or SEARCH is used.  Excess results are ignored.
+        esearch_result = extract_responses("ESEARCH") {|response|
+          response in ESearchResult(tag: ^tag)
+        }.last
+        search_result = clear_responses("SEARCH").last
+        if esearch_result
+          # silently ignore SEARCH results, if any
+          esearch_result
+        elsif search_result
+          # warn EXPECTED_ESEARCH_RESULT if esearch
+          search_result
+        elsif esearch
+          # warn NO_SEARCH_RESPONSE
+          ESearchResult[tag:, uid: cmd.start_with?("UID ")]
+        else
+          # warn NO_SEARCH_RESPONSE
+          SearchResult[]
+        end
       end
     end
 
@@ -3198,7 +3440,7 @@ module Net
     end
 
     def normalize_searching_criteria(criteria)
-      return RawData.new(criteria) if criteria.is_a?(String)
+      return [RawData.new(criteria)] if criteria.is_a?(String)
       criteria.map {|i|
         if coerce_search_arg_to_seqset?(i)
           SequenceSet[i]
@@ -3276,6 +3518,7 @@ require_relative "imap/errors"
 require_relative "imap/config"
 require_relative "imap/command_data"
 require_relative "imap/data_encoding"
+require_relative "imap/data_lite"
 require_relative "imap/flags"
 require_relative "imap/response_data"
 require_relative "imap/response_parser"