aboutsummaryrefslogtreecommitdiffstats
path: root/doc/aerc-search.1.scd
diff options
context:
space:
mode:
authorKoni Marti <koni.marti@gmail.com>2024-07-04 22:41:36 +0200
committerRobin Jarry <robin@jarry.cc>2024-08-04 18:26:47 +0200
commit2cd0cec19d6146d6e9681b648d978f463b107008 (patch)
treef1863cb7783e2895ea9bd494e6bc1f55db1e220b /doc/aerc-search.1.scd
parentf913070600236e9298eb5703794665562a348987 (diff)
downloadaerc-2cd0cec19d6146d6e9681b648d978f463b107008.tar.gz
search,filter: add flag to use custom extensions
Add an extension flag to the search/filter command which will provide different completion strategies for the search terms and instruct the backend to use custom extensions (such as X-GM-EXT-1) if available. The following examples are based on the Gmail extension (note that this should be enabled in your accounts.conf with 'use-gmail-ext=true'): :filter -e filename:pdf from:bob :filter -e has:attachment newer_than:2d :search -e is:read is:starred :search -e list:~rjarry/aerc-devel@lists.sr.ht Signed-off-by: Koni Marti <koni.marti@gmail.com> Tested-by: Inwit <inwit@sindominio.net> Acked-by: Robin Jarry <robin@jarry.cc>
Diffstat (limited to 'doc/aerc-search.1.scd')
-rw-r--r--doc/aerc-search.1.scd23
1 files changed, 21 insertions, 2 deletions
diff --git a/doc/aerc-search.1.scd b/doc/aerc-search.1.scd
index 3f4b61c8..e6e80e4c 100644
--- a/doc/aerc-search.1.scd
+++ b/doc/aerc-search.1.scd
@@ -8,8 +8,8 @@ aerc-search - search and filter patterns and options for *aerc*(1)
This syntax is common to all backends.
-*:filter* [*-ruba*] [*-x* _<flag>_] [*-X* _<flag>_] [*-H* _<header>:[<value>]_] [*-f* _<from>_] [*-t* _<to>_] [*-c* _<cc>_] [*-d* _<start[..end]>_] [_<terms>_...]++
-*:search* [*-ruba*] [*-x* _<flag>_] [*-X* _<flag>_] [*-H* _<header>:[<value>]_] [*-f* _<from>_] [*-t* _<to>_] [*-c* _<cc>_] [*-d* _<start[..end]>_] [_<terms>_...]
+*:filter* [*-rubae*] [*-x* _<flag>_] [*-X* _<flag>_] [*-H* _<header>:[<value>]_] [*-f* _<from>_] [*-t* _<to>_] [*-c* _<cc>_] [*-d* _<start[..end]>_] [_<terms>_...]++
+*:search* [*-rubae*] [*-x* _<flag>_] [*-X* _<flag>_] [*-H* _<header>:[<value>]_] [*-f* _<from>_] [*-t* _<to>_] [*-c* _<cc>_] [*-d* _<start[..end]>_] [_<terms>_...]
Searches the current folder for messages matching the given set of
conditions.
@@ -47,6 +47,10 @@ This syntax is common to all backends.
*-a*: Search in the entire text of the messages
+ *-e*: Instruct the backend to use a custom search extension
+ (such as the X-GM-EXT if available). Search terms are expected
+ in _<terms>_; other flags will be ignored.
+
*-f* _<from>_: Search for messages from _<from>_
*-t* _<to>_: Search for messages to _<to>_
@@ -78,6 +82,21 @@ This syntax is common to all backends.
correspond to _1d_ (equivalent to _1 day_ or _1_day_)
and _8 days ago_ would be either _1w1d_ or _8d_.
+# CUSTOM IMAP EXTENSIONS
+
+The Gmail IMAP extension (X-GM-EXT-1) can be used for searching and filtering.
+To use this custom extension, make sure it is activated (see *aerc-imap*(5))
+and use the extension *-e* flag in your *:filter* or *:search* commands.
+
+ Example:
+
+ :filter -e filename:pdf from:bob
+ :filter -e has:attachment newer_than:2d
+
+ :search -e is:read is:starred
+ :search -e list:~rjarry/aerc-devel@lists.sr.ht
+
+
# NOTMUCH
For notmuch, it is possible to avoid using the above flags and only rely on