Skip to content

📚 Document SearchResult/ESearchResult compatibility #559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nevans merged 1 commit into from
Nov 29, 2025
+12 −0
Merged

📚 Document SearchResult/ESearchResult compatibility #559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions lib/net/imap/esearch_result.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ class IMAP
# Some search extensions may result in the server sending ESearchResult
# responses after the initiating command has completed. Use
# IMAP#add_response_handler to handle these responses.
#
# ==== Compatibility with SearchResult
#
# Note that both SearchResult and ESearchResult implement +each+, +to_a+,
# and +to_sequence_set+. These methods can be used regardless of whether
# the server returns +SEARCH+ or +ESEARCH+ data (or no data).
class ESearchResult < Data.define(:tag, :uid, :data)
def initialize(tag: nil, uid: nil, data: nil)
tag => String | nil; tag = -tag if tag
Expand Down
6 changes: 6 additions & 0 deletions lib/net/imap/search_result.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ class IMAP
# identifiers returned by Net::IMAP#uid_search.
#
# For backward compatibility, SearchResult inherits from Array.
#
# ==== Compatibility with ESearchResult
#
# Note that both SearchResult and ESearchResult implement +each+, +to_a+,
# and +to_sequence_set+. These methods can be used regardless of whether
# the server returns +SEARCH+ or +ESEARCH+ data (or no data).
class SearchResult < Array

# Returns a SearchResult populated with the given +seq_nums+.
Expand Down