@@ -1971,8 +1971,9 @@ def uid_expunge(uid_set)
1971
1971
# the server to return an ESearchResult instead of a SearchResult, but some
1972
1972
# servers disobey this requirement. <em>Requires an extended search
1973
1973
# capability, such as +ESEARCH+ or +IMAP4rev2+.</em>
1974
- # See {"Argument translation"}[rdoc-ref:#search@Argument+translation]
1975
- # and {"Return options"}[rdoc-ref:#search@Return+options], below.
1974
+ # See {"Argument translation"}[rdoc-ref:#search@Argument+translation] and
1975
+ # {"Supported return options"}[rdoc-ref:#search@Supported+return+options],
1976
+ # below.
1976
1977
#
1977
1978
# +charset+ is the name of the {registered character
1978
1979
# set}[https://www.iana.org/assignments/character-sets/character-sets.xhtml]
@@ -2082,33 +2083,46 @@ def uid_expunge(uid_set)
2082
2083
# <em>*WARNING:* This is vulnerable to injection attacks when external
2083
2084
# inputs are used.</em>
2084
2085
#
2085
- # ==== Return options
2086
+ # ==== Supported return options
2086
2087
#
2087
2088
# For full definitions of the standard return options and return data, see
2088
2089
# the relevant RFCs.
2089
2090
#
2090
- # ===== +ESEARCH+ or +IMAP4rev2+
2091
- #
2092
- # The following return options require either +ESEARCH+ or +IMAP4rev2+.
2093
- # See [{RFC4731 §3.1}[https://rfc-editor.org/rfc/rfc4731#section-3.1]] or
2094
- # [{IMAP4rev2 §6.4.4}[https://www.rfc-editor.org/rfc/rfc9051.html#section-6.4.4]].
2095
- #
2096
2091
# [+ALL+]
2097
2092
# Returns ESearchResult#all with a SequenceSet of all matching sequence
2098
2093
# numbers or UIDs. This is the default, when return options are empty.
2099
2094
#
2100
2095
# For compatibility with SearchResult, ESearchResult#to_a returns an
2101
2096
# Array of message sequence numbers or UIDs.
2097
+ #
2098
+ # <em>Requires either the +ESEARCH+ or +IMAP4rev2+ capabability.</em>
2099
+ # {[RFC4731]}[https://rfc-editor.org/rfc/rfc4731]
2100
+ # {[RFC9051]}[https://rfc-editor.org/rfc/rfc9051]
2101
+ #
2102
2102
# [+COUNT+]
2103
2103
# Returns ESearchResult#count with the number of matching messages.
2104
+ #
2105
+ # <em>Requires either the +ESEARCH+ or +IMAP4rev2+ capabability.</em>
2106
+ # {[RFC4731]}[https://rfc-editor.org/rfc/rfc4731]
2107
+ # {[RFC9051]}[https://rfc-editor.org/rfc/rfc9051]
2108
+ #
2104
2109
# [+MAX+]
2105
2110
# Returns ESearchResult#max with the highest matching sequence number or
2106
2111
# UID.
2112
+ #
2113
+ # <em>Requires either the +ESEARCH+ or +IMAP4rev2+ capabability.</em>
2114
+ # {[RFC4731]}[https://rfc-editor.org/rfc/rfc4731]
2115
+ # {[RFC9051]}[https://rfc-editor.org/rfc/rfc9051]
2116
+ #
2107
2117
# [+MIN+]
2108
2118
# Returns ESearchResult#min with the lowest matching sequence number or
2109
2119
# UID.
2110
2120
#
2111
- # ===== +CONDSTORE+
2121
+ # <em>Requires either the +ESEARCH+ or +IMAP4rev2+ capabability.</em>
2122
+ # {[RFC4731]}[https://rfc-editor.org/rfc/rfc4731]
2123
+ # {[RFC9051]}[https://rfc-editor.org/rfc/rfc9051]
2124
+ #
2125
+ # ===== +MODSEQ+ return data
2112
2126
#
2113
2127
# ESearchResult#modseq return data does not have a corresponding return
2114
2128
# option. Instead, it is returned if the +MODSEQ+ search key is used or
@@ -2120,8 +2134,8 @@ def uid_expunge(uid_set)
2120
2134
#
2121
2135
# {RFC4466 §2.6}[https://www.rfc-editor.org/rfc/rfc4466.html#section-2.6]
2122
2136
# defines standard syntax for search extensions. Net::IMAP allows sending
2123
- # unknown search return options and will parse unknown search extensions'
2124
- # return values into ExtensionData. Please note that this is an
2137
+ # unsupported search return options and will parse unsupported search
2138
+ # extensions' return values into ExtensionData. Please note that this is an
2125
2139
# intentionally _unstable_ API. Future releases may return different
2126
2140
# (incompatible) objects, <em>without deprecation or warning</em>.
2127
2141
#
0 commit comments