✨ Add basic ESearch support #333
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
FWIW: I discovered in testing that Yahoo does not return ESEARCH results when |
nevans
force-pushed
the
basic-esearch-support
branch
4 times, most recently
from
59137e9
to
7dc2006
Compare
nevans
added a commit
to nevans/net-imap
that referenced
this pull request
Nov 8, 2024
This affects `#search`, `#uid_search`, `#sort`, `#uid_sort`, `#thread`,
and `#uid_thread`.
Prior to this, sending a parenthesized list in the search criteria for
any of these commands required the use of strings, which are converted
to `RawData`, which has security implications with untrusted inputs.
With this change, arrays will only be converted into SequenceSet when
_every_ element in the array is a valid SequenceSet input. Otherwise,
the array will be left alone, which allows us to send parenthesized
lists without using strings and RawData.
For example, some searches this change enables:
* Combining criteria to pass into `OR`, `NOT`, `FUZZY`, etc.
* `search(["not", %w(flagged unread)])`
converts to: `SEARCH not (flagged unread)`
* Adding return options (we should also add a return kwarg).
* `uid_search(["RETURN", ["PARTIAL", 1..50], "UID", 12345..67890])`
converts to: `UID SEARCH RETURN (PARTIAL 1:50) UID 12345:67890`
* Note that `PARTIAL` supports negative ranges, which can't be coerced
to SequenceSet. They'll need to be sent as strings, for now.
* Note that searches with return options should return ESEARCH
results, which are currently unsupported. See ruby#333.
This _should_ be backward compatible: previously these inputs would
raise an exception.
nevans
force-pushed
the
basic-esearch-support
branch
2 times, most recently
from
d86e849
to
efd2760
Compare
nevans
force-pushed
the
basic-esearch-support
branch
from
efd2760
to
0587646
Compare
nevans
force-pushed
the
basic-esearch-support
branch
5 times, most recently
from
26211ba
to
fd7b0f9
Compare
For new data structs, I don't want to commit to supporting the entire Struct API and I'd prefer frozen by default. `Data` is exactly what I want but it's not available until ruby 3.2. So this adds a DataLite class that closely matches ruby 3.2's Data class and can be a drop-in replacement for Data. Net::IMAP::Data is an alias for Net::IMAP::DataLite, so when we remove this implementation, the constant will resolve to ruby's ::Data. The most noticable incompatibility is that member names must be valid local variable names. Ideally, we wouldn't define this on newer ruby versions at all, but that breaks the YAML serialization for our test fixtures. So, on newer versions of ruby, this class inherits from `Data` and only reimplements the two methods that are needed for YAML serialization. This serves the additional purpose of ensuring that the same tests pass for both the core `Data` class and our reimplementation. Most of the test code and some of the implementation code has been copied from the polyfill-data gem and updated so that they use "Data" as it is resolved inside the "Net::IMAP" namespace. Copyright notices have been added to the appropriate files to satisfy the MIT license terms. Co-authored-by: Jim Gay <[email protected]>
The new `CommandData` superclass uses `Data` to add the pattern matching and equality methods while also simplifying the implementation. Specifically, I wanted RawData#deconstruct for the basic `ESEARCH` support branch. It seemed reasonable to apply the same change to all of the internal command data classes. Please note: this does change these objects to be frozen. However, these classes are explicitly undocumented and considered "internal", so this will _not_ be treated as a "breaking change".
Parses +ESEARCH+ into ESearchResult, with support for: * RFC4466 syntax * RFC4731 `ESEARCH` * RFC5267 `CONTEXT=SEARCH` * RFC6203 `SEARCH=FUZZY` * RFC9394 `PARTIAL` For compatibility, `ESearchResult#to_a` returns an array of integers (sequence numbers or UIDs) whenever any `ALL` or `PARTIAL` result is available.
If the server returns both `ESEARCH` and `SEARCH`, both are cleared from the responses hash, but only the `ESEARCH` is returned. When the server doesn't send any search responses: If return options are passed, return an empty ESearchResult. It will have the appropriate `tag` and `uid` values, but no `data`. Otherwise return an empty `SearchResult` (changed from empty array).
nevans
force-pushed
the
basic-esearch-support
branch
from
fd7b0f9
to
a535b1f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.