Skip to content
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

Jump to bottom

📚 Update #search documentation #347

Merged
merged 2 commits into from
Nov 7, 2024
Merged

📚 Update #search documentation #347

merged 2 commits into from
Nov 7, 2024

Commits on Nov 7, 2024

  1. 📚 Update #search documentation 

    * 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.
    @nevans
    nevans committed Nov 7, 2024
    Configuration menu
    Copy the full SHA
    f0d7c3d View commit details
    Browse the repository at this point in the history

  2. 📚 Document all known standard search keys 

    Rather than only list a subset of search keys, this documents them all.
    @nevans
    nevans committed Nov 7, 2024
    Configuration menu
    Copy the full SHA
    a366a0d View commit details
    Browse the repository at this point in the history