📚 Update #search documentation
#347
Merged
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
* Expanded criteria docs: * explain sequence-set coercion * explain encoding of string, integer, and date args * add warning for raw string data * Expanded charset docs * Link to IANA charset registry * Indicate defaults are "US-ASCII" or "UTF-8" * Demonstrate sending charset embedded inside criteria * Move `#search` example above search criteria. The list of search keys is long. And to be more complete, it will need to get even longer. It's nice to have some examples near the top. * Update `#search` example (`NEW` is deprecated) `NEW` and `RECENT` have been removed from `IMAP4rev2`, so I'm updating the example with a search key that isn't deprecated.
Rather than only list a subset of search keys, this documents them all.
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.
#searchexample above search criteria. The list of search keysis long. And to be more complete, it will need to get even longer.
It's nice to have some examples near the top.
#searchexample (NEWis deprecated)NEWandRECENThave been removed fromIMAP4rev2, so I'm updatingthe example with a search key that isn't deprecated.
CONDSTOREexample