man: improve mu-query manpage

This commit is contained in:
Dirk-Jan C. Binnema
2024-12-01 23:45:28 +02:00
parent ed4d0f5e9d
commit 05be072676

View File

@ -121,45 +121,71 @@ full table with all details, including single-char shortcuts, try the command:
#+ATTR_MAN: :disable-caption t #+ATTR_MAN: :disable-caption t
#+begin_example #+begin_example
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| flag | shortcut | category | description | | field-name | alias | short | search | value | sexp | example query | description |
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| draft | D | file | Draft (in progress) | | bcc | | h | phrase | yes | yes | bcc:foo@example.com | Blind carbon-copy recipient |
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| flagged | F | file | User-flagged | | body | | b | phrase | no | no | body:capybara | Message plain-text body |
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| passed | P | file | Forwarded message | | cc | | c | phrase | yes | yes | cc:quinn@example.com | Carbon-copy recipient |
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| replied | R | file | Replied-to | | changed | | k | range | yes | yes | changed:30M.. | Last change time |
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| seen | S | file | Viewed at least once | | date | | d | range | yes | yes | date:20220101..20220505 | Message date |
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| trashed | T | file | Marked for deletion | | embed | | e | phrase | no | no | embed:war OR embed:peace | Embedded text |
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| new | N | maildir | New message | | file | | j | boolean | no | no | file:/image\.*.jpg/ | Attachment file name |
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| signed | z | content | Cryptographically signed | | flags | flag | g | boolean | yes | yes | flag:unread AND flag:personal | Message properties |
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| encrypted | x | content | Encrypted | | from | | f | phrase | yes | yes | from:jimbo | Message sender |
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| attach | a | content | Has at least one attachment | | language | lang | a | boolean | yes | yes | lang:nl | ISO 639-1 language code for body |
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| unread | u | pseudo | New or not seen message | | maildir | | m | boolean | yes | yes | maildir:/private/archive | Maildir path for message |
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| list | l | content | Mailing list message | | list | | v | boolean | yes | yes | list:mu-discuss.example.com | Mailing list (List-Id:) |
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| personal | q | content | Personal message | | message-id | msgid | i | boolean | yes | yes | msgid:abc@123 | Message-Id |
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| calendar | c | content | Calendar invitation | | mime | mime-type | y | boolean | no | no | mime:image/jpeg | Attachment MIME-type |
+-----------+----------+----------+-----------------------------+ +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| path | | l | boolean | yes | yes | path:/a/b/Maildir/cur/msg:2,S | File system path to message |
+------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| priority | prio | p | boolean | yes | yes | prio:high | Priority |
+------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| references | ref | r | boolean | yes | yes | | References to related messages |
+------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| size | | z | range | yes | yes | size:1M..5M | Message size in bytes |
+------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| subject | | s | phrase | yes | yes | subject:wombat | Message subject |
+------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| tags | tag | x | boolean | yes | yes | tag:projectx | Message tags |
+------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| thread | | w | boolean | yes | no | | Thread a message belongs to |
+------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
| to | | t | phrase | yes | yes | to:flimflam@example.com | Message recipient |
+------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
#+end_example #+end_example
(*) The language code for the text-body if found. This works only if *mu* was There are also *combination fields* which allow you to search for multiple related
built with CLD2 support. fields at once:
There are also the special fields *contact:*, which matches all contact-fields #+ATTR_MAN: :disable-caption t
(=from=, =to=, =cc= and =bcc=), and *recip*, which matches all recipient-fields (=to=, =cc= #+begin_example
and =bcc=). # Combination fields
+-------------+-----------------------------------------+
| combi-field | fields |
+-------------+-----------------------------------------+
| recip | to, cc, bcc |
+-------------+-----------------------------------------+
| contact | to, cc, bcc, from |
+-------------+-----------------------------------------+
| <empty> | to, cc, bcc, from, subject, body, embed |
+-------------+-----------------------------------------+
#+end_example
Hence, for instance, Hence, for instance,
#+begin_example #+begin_example
@ -294,7 +320,7 @@ maildir:/
#+end_example #+end_example
If you have maildirs (or any fields) that include spaces, you need to quote If you have maildirs (or any fields) that include spaces, you need to quote
them, ie. them, i.e.,
#+begin_example #+begin_example
maildir:"/Sent Items" maildir:"/Sent Items"
#+end_example #+end_example
@ -349,6 +375,13 @@ Find all messages with attached images:
#+begin_example #+begin_example
mime:image/* mime:image/*
#+end_example #+end_example
(and beware that on the command-line, you need to put this in quotes or it would
expand the ~*~.
Find a messages with the given message-id:
#+begin_example
msgid:CAE56pjGU2oNxN-wWku69@mail.gmail.com
#+end_example
Find all messages written in Dutch or German with the word `hallo': Find all messages written in Dutch or German with the word `hallo':
#+begin_example #+begin_example