Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions lib/net/imap.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2255,6 +2255,7 @@ def uid_expunge(uid_set)
# provided as an array or a string.
# See {"Argument translation"}[rdoc-ref:#search@Argument+translation]
# and {"Search criteria"}[rdoc-ref:#search@Search+criteria], below.
# <em>Please note</em> the warning for when +criteria+ is a String.
#
# +return+ options control what kind of information is returned about
# messages matching the search +criteria+. Specifying +return+ should force
Expand Down Expand Up @@ -2665,7 +2666,8 @@ def search(...)
# backward compatibility) but adds SearchResult#modseq when the +CONDSTORE+
# capability has been enabled.
#
# See #search for documentation of parameters.
# See #search for documentation of parameters. <em>Please note</em> the
# warning for when +criteria+ is a String.
#
# ==== Capabilities
#
Expand Down Expand Up @@ -2751,7 +2753,8 @@ def fetch(...)
# {SequenceSet[...]}[rdoc-ref:SequenceSet@Creating+sequence+sets].
# (For message sequence numbers, use #fetch instead.)
#
# +attr+ behaves the same as with #fetch.
# +attr+ behaves the same as with #fetch. <em>Please note</em> the #fetch
# warning on the +attr+ argument.
# >>>
# *Note:* Servers _MUST_ implicitly include the +UID+ message data item as
# part of any +FETCH+ response caused by a +UID+ command, regardless of
Expand Down Expand Up @@ -2963,8 +2966,10 @@ def uid_move(set, mailbox)

# Sends a {SORT command [RFC5256 §3]}[https://www.rfc-editor.org/rfc/rfc5256#section-3]
# to search a mailbox for messages that match +search_keys+ and return an
# array of message sequence numbers, sorted by +sort_keys+. +search_keys+
# are interpreted the same as for #search.
# array of message sequence numbers, sorted by +sort_keys+.
#
# +search_keys+ are interpreted the same as the +criteria+ argument for
# #search. <em>Please note</em> the #search warning for String +criteria+.
#
#--
# TODO: describe +sort_keys+
Expand All @@ -2989,8 +2994,10 @@ def sort(sort_keys, search_keys, charset)

# Sends a {UID SORT command [RFC5256 §3]}[https://www.rfc-editor.org/rfc/rfc5256#section-3]
# to search a mailbox for messages that match +search_keys+ and return an
# array of unique identifiers, sorted by +sort_keys+. +search_keys+ are
# interpreted the same as for #search.
# array of unique identifiers, sorted by +sort_keys+.
#
# +search_keys+ are interpreted the same as the +criteria+ argument for
# #search. <em>Please note</em> the #search warning for String +criteria+.
#
# Related: #sort, #search, #uid_search, #thread, #uid_thread
#
Expand All @@ -3004,8 +3011,10 @@ def uid_sort(sort_keys, search_keys, charset)

# Sends a {THREAD command [RFC5256 §3]}[https://www.rfc-editor.org/rfc/rfc5256#section-3]
# to search a mailbox and return message sequence numbers in threaded
# format, as a ThreadMember tree. +search_keys+ are interpreted the same as
# for #search.
# format, as a ThreadMember tree.
#
# +search_keys+ are interpreted the same as the +criteria+ argument for
# #search. <em>Please note</em> the #search warning for String +criteria+.
#
# The supported algorithms are:
#
Expand All @@ -3031,6 +3040,9 @@ def thread(algorithm, search_keys, charset)
# Similar to #thread, but returns unique identifiers instead of
# message sequence numbers.
#
# +search_keys+ are interpreted the same as the +criteria+ argument for
# #search. <em>Please note</em> the #search warning for String +criteria+.
#
# Related: #thread, #search, #uid_search, #sort, #uid_sort
#
# ==== Capabilities
Expand Down
Loading