Skip to content

Commit

Permalink
📚 Update docs for #sort, #uid_sort, & #thread [🚧 sort_keys]
Browse files Browse the repository at this point in the history
  • Loading branch information
nevans committed Dec 19, 2022
1 parent 527cf95 commit ef8ecb2
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions lib/net/imap.rb
Original file line number Diff line number Diff line change
Expand Up @@ -1461,8 +1461,13 @@ def uid_move(set, mailbox)
end

# Sends a {SORT command [RFC5256 §3]}[https://www.rfc-editor.org/rfc/rfc5256#section-3]
# to sort messages in the mailbox. Returns an array of message sequence
# numbers.
# 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.
#
#--
# TODO: describe +sort_keys+
#++
#
# Related: #uid_sort, #search, #uid_search, #thread, #uid_thread
#
Expand All @@ -1482,7 +1487,9 @@ def sort(sort_keys, search_keys, charset)
end

# Sends a {UID SORT command [RFC5256 §3]}[https://www.rfc-editor.org/rfc/rfc5256#section-3]
# to sort messages in the mailbox. Returns an array of unique identifiers.
# 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.
#
# Related: #sort, #search, #uid_search, #thread, #uid_thread
#
Expand Down Expand Up @@ -1517,8 +1524,11 @@ def remove_response_handler(handler)
end

# Sends a {THREAD command [RFC5256 §3]}[https://www.rfc-editor.org/rfc/rfc5256#section-3]
# Similar to #search, but returns message sequence numbers in threaded
# format, as a ThreadMember tree. The supported algorithms are:
# 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.
#
# The supported algorithms are:
#
# ORDEREDSUBJECT:: split into single-level threads according to subject,
# ordered by date.
Expand Down

0 comments on commit ef8ecb2

Please sign in to comment.