mu-mcp

mu find $query

   For example:

      $ mu find subject:snow and date:2009..



   would find all messages in 2009 with `snow' in the subject field, e.g:

      2009-03-05 17:57:33 EET Lucia  <lucia@example.com> running in the snow
      2009-03-05 18:38:24 EET Marius <marius@foobar.com> Re: running in the snow



   Note, this the default, plain-text output, which is the default, so you
   don't have to use --format=plain. For other types of output (such as
   symlinks, XML or s-expressions), see the discussion in the
   OPTIONS-section below about --format.


   The search pattern is taken as a command-line parameter. If the search
   parameter consists of multiple parts (as in the example) they are
   treated as if there were a logical and between them.


   For details on the possible queries, see mu-query(7).

   The find-command has various options that influence the way mu displays
   the results. If you don't specify anything, the defaults are
   --fields="d f s", --sortfield=date and --reverse.

   For example:

      $ mu find subject:snow --fields "d f s"



   lists the date, subject and sender of all messages with `snow' in the
   their subject.


   The table of replacement characters is superset of the list mentions
   for search parameters, such as:
      t       *t*o: recipient
      d       Sent *d*ate of the message
      f       Message sender (*f*rom:)
      g       Message flags (fla*g*s)
      l       Full path to the message (*l*ocation)
      s       Message *s*ubject
      i       Message-*i*d
      m       *m*aildir



   For the complete list, try the command: mu info fields.


   The message flags are described in mu-query(7). As an example, a
   message which is `seen', has an attachment and is signed would have
   `asz' as its corresponding output string, while an encrypted new
   message would have `nx'.

      cc,c	      Cc (carbon-copy) recipient(s)
      date,d	      Message sent date
      from,f	      Message sender
      maildir,m       Maildir
      msgid,i	      Message id
      prio,p	      Nessage priority
      subject,s       Message subject
      to,t	      To:-recipient(s)



   For the complete list, try the command: mu info fields.


   Thus, for example, to sort messages by date, you could specify:

      $ mu find fahrrad --fields "d f s" --sortfield=date --reverse



   Note, if you specify a sortfield, by default, messages are sorted in
   reverse (descending) order (e.g., from lowest to highest). This is
   usually a good choice, but for dates it may be more useful to sort in
   the opposite direction.

   —   The default is plain, i.e normal output with one line per message.

   —   links outputs the results as a maildir with symbolic links to the
   found messages. This enables easy integration with mail-clients
   (see below for more information). This requires --linksdir.

   —   xml formats the search results as XML.

   —   sexp formats the search results as an s-expression as used in Lisp
   programming environments.

   If you specify --clearlinks, existing symlinks will be cleared from the
   target directories; this allows for re-use of the same maildir.
   However, this option will delete any symlink it finds, so be careful.

      $ mu find grolsch --format=links --linksdir=~/Maildir/search --clearlinks



   stores links to found messages in ~/Maildir/search. If the directory
   does not exist yet, it will be created. Note: when mu creates a Maildir
   for these links, it automatically inserts a .noindex file, to exclude
   the directory from mu index.

   From the command line, you can use the date command to get this value.
   For example, only consider messages modified (or created) in the last 5
   minutes, you could specify
      --after=`date +%s --date='5 min ago'`


   This is assuming the GNU date command.

   which is roughly equivalent to:
      $ mu find milkshake --fields="l" | xargs less

   Messages in the threaded list are indented based on the depth in the
   discussion, and are prefix with a kind of arrow with thread-related
   information about the message, as in the following table:
      | 	    | normal | orphan | duplicate |
      |-------------+--------+--------+-----------|
      | first child | `->    | `*>    | `=>	  |
      | other	    | |->    | |*>    | |=>	  |



   Here, an `orphan' is a message without a parent message (in the list of
   matches), and a duplicate is a message whose message-id was already
   seen before; not this may not really be the same message, if the
   message-id was copied.


   The algorithm used for determining the threads is based on Jamie
   Zawinksi's description: http://www.jwz.org/doc/threading.html

   The output of this command are differ between versions, but should be
   helpful nevertheless.

   The environment variable MUHOME can be used as an alternative to
   --muhome. The latter has precedence.

      # mutt macros for mu
      macro index <F8> "<shell-escape>mu find --clearlinks --format=links --linksdir=~/Maildir/search " \\
			       "mu find"
      macro index <F9> "<change-folder-readonly>~/Maildir/search" \\
			       "mu find results"

      (require 'elmo-search)
      (elmo-search-register-engine
	  'mu 'local-file
	  :prog "/usr/local/bin/mu" ;; or wherever you've installed it
	  :args '("find" pattern "--fields" "l") :charset 'utf-8)

      (setq elmo-search-default-engine 'mu)
      ;; for when you type "g" in folder or summary.
      (setq wl-default-spec "[")



   Now, you can search using the g key binding; you can also create
   permanent virtual folders when the messages matching some expression by
   adding something like the following to your folders file.

      VFolders {
	[date:today..now]!mu  "Today"
	[size:1m..100m]!mu    "Big"
	[flag:unread]!mu      "Unread"
      }



   After restarting Wanderlust, the virtual folders should appear.MU QUERY(7)	       Miscellaneous Information Manual 	   MU QUERY(7)

   Here, we give a structured but informal overview of the query language
   and provide examples. As a companion to this, we recommend the mu info
   fields command to get an up-to-date list of the available fields and
   flags.


   Furthermore, mu find provides the --analyze option, which shows how mu
   interprets your query; similarly, mu4e has a command. mu4e-analyze-
   last-query.  See the ANALYZING QUERIES section for further details.


   NOTE: if you use queries on the command-line (say, for mu find), you
   need to quote any characters that would otherwise be interpreted by the
   shell, such as *--analyze option can be useful.

   Some example queries:

      vacation
      subject:capybara
      maildir:/inbox



   Terms without an explicit field-prefix, (like "vacation" above) are
   interpreted as:

      to:vacation or subject:vacation or body:vacation or ...



   The language is case-insensitive for terms and attempts to "flatten"
   diacritics, so angtrom matches Ångström.


   If terms contain whitespace, they need to be quoted.

      subject:"hi there"



   This is a so-called phrase query, which means that we match against
   subjects that contain the literal phrase "hi there". Phrase queries
   only work for certain fields; they have the word phrase in their mu
   info fields search column.

   In this case, that means the difference between search for a subject
   "hi there" versus and subject "hi" and some word "there" that can
   appear in any of the combination fields for <empty> (combination fields
   are discussed below).


   We can use the mentioned --analyze option to show the difference:


   #+begin_example mu find subject:"hi there" --analyze

   And with quotes escaped:


   #+begin_example mu find subject:$

   We won't dwell on the details of the --analyze output here, but
   hopefully this illustrates the difference between quoted and unquoted
   queries.

   You can also group things with ( and ), so you can write:
      (subject:beethoven or subject:bach) and not body:elvis



   If you do not explicitly specify an operator between terms, and is
   implied, so the queries
      subject:chip subject:dale

      subject:chip AND subject:dale


   are equivalent. For readability, we recommend the second version.


   Note that a pure not - e.g. searching for not apples is quite a "heavy"
   query.

   A search term with a rightmost * (and only in that position) matches
   any term that starts with the part before the *; they are less powerful
   than regular expressions, but also much faster:


   An example:
      $ mu find "hello*"



   Quoting the "hello*" is recommended; some shells (but not all) would
   otherwise expand the '*' to all files in the current directory.

   Regular expressions are enclosed in //. For example:

      subject:/h.llo/	       # match hallo, hello, ...



   Note the difference between "maildir:/foo" and "maildir:/foo/"; the
   former matches messages in the "/foo" maildir, while the latter matches
   all messages in all maildirs that match "foo", such as "/foo",
   "/bar/cuux/foo", "/fooishbar", and so on.


   Regular expressions are more powerful than wildcards, but are also much
   slower.	Moreover, their behavior in mu can be a bit confusing, due to
   some implementation details. See below for some of the caveats.

   (with the $ 40 specifying a space in the regular expression, and and
   extra '$´ to escape it). In many cases,
      mu find 'subject:/hello.world/'


   may be good enough, and easier to type.

   That implementation detail explain why "anchored" regular expressions
   (with ^ and $ to mark begin/end, respectively) can get unexpected
   results.


   Suppose you want to match all messages that start with "pie", and you
   search with subject:/^pie/. This also matches messages with subject
   "apple pie", since both those words are indexed as terms separately (as
   well as phrases), and thus "^pie" matches as well for a message with
   subject "apple pie".

      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
      | field-name | alias     | short | search  | value | sexp | example query 		| description			   |
      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
      | bcc	   |	       | h     | phrase  | yes	 | yes	| bcc:foo@example.com		| Blind carbon-copy recipient	   |
      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
      | body	   |	       | b     | phrase  | no	 | no	| body:capybara 		| Message plain-text body	   |
      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
      | cc	   |	       | c     | phrase  | yes	 | yes	| cc:quinn@example.com		| Carbon-copy recipient 	   |
      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
      | changed    |	       | k     | range	 | yes	 | yes	| changed:30M.. 		| Last change time		   |
      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
      | date	   |	       | d     | range	 | yes	 | yes	| date:20220101..20220505	| Message date			   |
      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
      | embed	   |	       | e     | phrase  | no	 | no	| embed:war OR embed:peace	| Embedded text 		   |
      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
      | file	   |	       | j     | boolean | no	 | no	| file:/image\.*.jpg/		| Attachment file name		   |
      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
      | flags	   | flag      | g     | boolean | yes	 | yes	| flag:unread AND flag:personal | Message properties		   |
      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
      | from	   |	       | f     | phrase  | yes	 | yes	| from:jimbo			| Message sender		   |
      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
      | language   | lang      | a     | boolean | yes	 | yes	| lang:nl			| ISO 639-1 language code for body |
      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
      | maildir    |	       | m     | boolean | yes	 | yes	| maildir:/private/archive	| Maildir path for message	   |
      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
      | list	   |	       | v     | boolean | yes	 | yes	| list:mu-discuss.example.com	| Mailing list (List-Id:)	   |
      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
      | message-id | msgid     | i     | boolean | yes	 | yes	| msgid:abc@123 		| Message-Id			   |
      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+
      | 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		   |
      +------------+-----------+-------+---------+-------+------+-------------------------------+----------------------------------+



   There are also combination fields which allow you to search for
   multiple related fields at once:

      # Combination fields
      +-------------+-----------------------------------------+
      | combi-field | fields				      |
      +-------------+-----------------------------------------+
      | recip	    | to, cc, bcc			      |
      +-------------+-----------------------------------------+
      | contact     | to, cc, bcc, from 		      |
      +-------------+-----------------------------------------+
      | related     | message-id, references		      |
      +-------------+-----------------------------------------+
      | <empty>     | to, cc, bcc, from, subject, body, embed |
      +-------------+-----------------------------------------+



   Hence, for instance,
      contact:fnorb@example.com


   is equivalent to
      (from:fnorb@example.com or to:fnorb@example.com or
	    cc:from:fnorb@example.com or bcc:fnorb@example.com)

   Dates are expressed in local time and using ISO-8601 format (YYYY-MM-DD
   HH:MM:SS); you can leave out the right part and mu adds the rest,
   depending on whether this is the beginning or end of the range (e.g.,
   as a lower bound, "2015" would be interpreted as the start of that
   year; as an upper bound as the end of the year).


   You can use `/' , `.', `-', `:' and "T" to make dates more human-
   readable.


   Some examples:
      date:20170505..20170602
      date:2017-05-05..2017-06-02
      date:..2017-10-01T12:00
      date:2015-06-01..
      date:2016..2016



   You can also use the special "dates" now and today:
      date:20170505..now
      date:today..



   Finally, you can use relative "ago" times which express some time
   before now and consist of a number followed by a unit, with units s for
   seconds, M for minutes, h for hours, d for days, w for week, m for
   months and y for years. Some examples:

      date:3m..
      date:2017.01.01..5w

      size:10k..2m
      size:10m..

   Some examples:
      flag:attach
      flag:replied
      g:x



   Encrypted messages may be signed as well, but this is only visible
   after decrypting and thus invisible to mu.

   Note the starting `/'. If you want to match mails in the "root"
   maildir, you can do with a single `/':
      maildir:/



   If you have maildirs (or any fields) that include spaces, you need to
   quote them, i.e.,
      maildir:"/Sent Items"



   And once again, note that when using the command-line, such queries
   must be quoted:
      mu find 'maildir:"/Sent Items"'



   Also note that you should not end the maildir with a /, or it can be
   misinterpreted as a regular expression term; see aforementioned.

   Find all messages with both "bee" and "bird" (in any field)
      bee AND bird



   Find all messages with either Frodo or Sam:
      Frodo OR Sam



   Find all messages with the "wombat" as subject, and "capybara"
   anywhere:
      subject:wombat and capybara



   Find all messages in the "Archive" folder from Fred:
      from:fred and maildir:/Archive



   Find all unread messages with attachments:
      flag:attach and flag:unread



   Find all messages with PDF-attachments:
      mime:application/pdf



   Find all messages with attached images:
      mime:image/*


   (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:
      msgid:CAE56pjGU2oNxN-wWku69@mail.gmail.com



   Find all messages written in Dutch or German with the word "hallo":
      hallo and (lang:nl or lang:de)



   This is only available if your mu has support for this; see mu info and
   check for "cld2-support*.