]> git.cworth.org Git - notmuch-wiki/blobdiff - manpages/notmuch-search-terms-7.mdwn
manpages for 0.24
[notmuch-wiki] / manpages / notmuch-search-terms-7.mdwn
index 40b082d54323d183619990e6a7f089553fb291c7..f92b7c4e791b7d3b24bdcac5f7f2bbdd2d8006a4 100644 (file)
 
        · from:<name-or-address>
 
+       · from:/<regex>/
+
        · to:<name-or-address>
 
        · subject:<word-or-quoted-phrase>
 
+       · subject:/<regex>/
+
        · attachment:<word>
 
        · mimetype:<word>
        including quotation marks around the phrase, immediately following <b>sub-</b>
        <b>ject:</b>.
 
+       If  notmuch is built with <b>Xapian</b> <b>Field</b> <b>Processors</b> (see below) the <b>from:</b>
+       and <b>subject</b> prefix can be also used to restrict the  results  to  those
+       whose  from/subject  value  matches a regular expression (see <b>regex</b>(7))
+       delimited with //.
+
+          notmuch search &apos;from:/bob@.*[.]example[.]com/&apos;
+
        The <b>attachment:</b> prefix can be used to search for specific filenames (or
        extensions) of attachments to email messages.
 
-       The <b>mimetype:</b> prefix will be used to match text from the  content-types
+       The  <b>mimetype:</b> prefix will be used to match text from the content-types
        of MIME parts within email messages (as specified by the sender).
 
-       For  <b>tag:</b>  and <b>is:</b> valid tag values include <b>inbox</b> and <b>unread</b> by default
-       for new messages added by <b>notmuch</b> <b>new</b> as well as any other  tag  values
+       For <b>tag:</b> and <b>is:</b> valid tag values include <b>inbox</b> and <b>unread</b>  by  default
+       for  new  messages added by <b>notmuch</b> <b>new</b> as well as any other tag values
        added manually with <b>notmuch</b> <b>tag</b>.
 
-       For  <b>id:</b>, message ID values are the literal contents of the Message-ID:
+       For <b>id:</b>, message ID values are the literal contents of the  Message-ID:
        header of email messages, but without the &apos;&lt;&apos;, &apos;&gt;&apos; delimiters.
 
-       The <b>thread:</b> prefix can be used with the thread ID values that are  gen‐
-       erated  internally  by  notmuch  (and do not appear in email messages).
-       These thread ID values can be seen in the first column of  output  from
+       The  <b>thread:</b> prefix can be used with the thread ID values that are gen‐
+       erated internally by notmuch (and do not  appear  in  email  messages).
+       These  thread  ID values can be seen in the first column of output from
        <b>notmuch</b> <b>search</b>
 
-       The  <b>path:</b>  prefix  searches  for email messages that are in particular
+       The <b>path:</b> prefix searches for email messages  that  are  in  particular
        directories within the mail store. The directory must be specified rel‐
-       ative  to  the  top-level  maildir  (and without the leading slash). By
-       default, <b>path:</b> matches messages in the specified  directory  only.  The
-       &quot;/**&quot;  suffix  can be used to match messages in the specified directory
-       and all its subdirectories recursively.  <b>path:&quot;&quot;</b>  matches  messages  in
+       ative to the top-level maildir (and  without  the  leading  slash).  By
+       default,  <b>path:</b>  matches  messages in the specified directory only. The
+       &quot;/**&quot; suffix can be used to match messages in the  specified  directory
+       and  all  its  subdirectories recursively.  <b>path:&quot;&quot;</b> matches messages in
        the root of the mail store and, likewise, <b>path:**</b> matches all messages.
 
        The <b>folder:</b> prefix searches for email messages by maildir or MH folder.
-       For MH-style folders, this is equivalent to <b>path:</b>.  For  maildir,  this
+       For  MH-style  folders,  this is equivalent to <b>path:</b>. For maildir, this
        includes messages in the &quot;new&quot; and &quot;cur&quot; subdirectories. The exact syn‐
-       tax for  maildir  folders  depends  on  your  mail  configuration.  For
-       maildir++,  <b>folder:&quot;&quot;</b>  matches  the  inbox folder (which is the root in
-       maildir++), other folder names always start with &quot;.&quot;, and nested  fold‐
-       ers  are separated by &quot;.&quot;s, such as <b>folder:.classes.topology</b>. For &quot;file
+       tax  for  maildir  folders  depends  on  your  mail  configuration. For
+       maildir++, <b>folder:&quot;&quot;</b> matches the inbox folder (which  is  the  root  in
+       maildir++),  other folder names always start with &quot;.&quot;, and nested fold‐
+       ers are separated by &quot;.&quot;s, such as <b>folder:.classes.topology</b>. For  &quot;file
        system&quot; maildir, the inbox is typically <b>folder:INBOX</b> and nested folders
        are separated by slashes, such as <b>folder:classes/topology</b>.
 
-       Both  <b>path:</b> and <b>folder:</b> will find a message if <u>any</u> copy of that message
+       Both <b>path:</b> and <b>folder:</b> will find a message if <u>any</u> copy of that  message
        is in the specific directory/folder.
 
-       The <b>date:</b> prefix can be used to restrict the results to  only  messages
+       The  <b>date:</b>  prefix can be used to restrict the results to only messages
        within a particular time range (based on the Date: header) with a range
        syntax of:
 
 
        &lt;initial-timestamp&gt;..&lt;final-timestamp&gt;
 
-       Each  timestamp  is  a  number representing the number of seconds since
+       Each timestamp is a number representing the  number  of  seconds  since
        1970-01-01 00:00:00 UTC.
 
-       The <b>lastmod:</b> prefix can be used to restrict the result by the  database
+       The  <b>lastmod:</b> prefix can be used to restrict the result by the database
        revision  number  of  when  messages  were  last  modified  (tags  were
-       added/removed or filenames changed).  This is usually used in  conjunc‐
-       tion  with  the <b>--uuid</b> argument to <b>notmuch</b> <b>search</b> to find messages that
+       added/removed  or filenames changed).  This is usually used in conjunc‐
+       tion with the <b>--uuid</b> argument to <b>notmuch</b> <b>search</b> to find  messages  that
        have changed since an earlier query.
 
-       The <b>query:</b> prefix allows queries to refer to previously  saved  queries
-       added  with <a href='../notmuch-config-1/'>notmuch-config</a>(1). Named queries are only available if not‐
+       The  <b>query:</b>  prefix allows queries to refer to previously saved queries
+       added with <a href='../notmuch-config-1/'>notmuch-config</a>(1). Named queries are only available if  not‐
        much is built with <b>Xapian</b> <b>Field</b> <b>Processors</b> (see below).
 
-       The  <b>property:</b>  prefix  searches  for  messages   with   a   particular
-       &lt;key&gt;=&lt;value&gt;  property pair. Properties are used internally by notmuch
-       (and extensions) to add metadata  to  messages.  A  given  key  can  be
+       The   <b>property:</b>   prefix   searches  for  messages  with  a  particular
+       &lt;key&gt;=&lt;value&gt; property pair. Properties are used internally by  notmuch
+       (and  extensions)  to  add  metadata  to  messages.  A given key can be
        present on a given message with several different values.
 </pre>
 
 <h3> &nbsp; Operators</h3>
 <pre>
-       In  addition  to  individual terms, multiple terms can be combined with
-       Boolean operators (<b>and</b>, <b>or</b>, <b>not</b>, and <b>xor</b>). Each term in the query  will
-       be  implicitly  connected  by  a logical AND if no explicit operator is
-       provided (except that terms with a common  prefix  will  be  implicitly
-       combined  with  OR).   The  shorthand  &apos;-&lt;term&gt;&apos;  can  be used for &apos;not
+       In addition to individual terms, multiple terms can  be  combined  with
+       Boolean  operators (<b>and</b>, <b>or</b>, <b>not</b>, and <b>xor</b>). Each term in the query will
+       be implicitly connected by a logical AND if  no  explicit  operator  is
+       provided  (except  that  terms  with a common prefix will be implicitly
+       combined with OR).  The  shorthand  &apos;-&lt;term&gt;&apos;  can  be  used  for  &apos;not
        &lt;term&gt;&apos; but unfortunately this does not work at the start of an expres‐
-       sion.   Parentheses  can also be used to control the combination of the
+       sion.  Parentheses can also be used to control the combination  of  the
        Boolean operators, but will have to be protected from interpretation by
        the shell, (such as by putting quotation marks around any parenthesized
        expression).
 
-       In addition to the standard boolean operators, Xapian provides  several
+       In  addition to the standard boolean operators, Xapian provides several
        operators specific to text searching.
 
           notmuch search term1 NEAR term2
 
-       will  return  results  where  term1  is  within  10 words of term2. The
+       will return results where term1  is  within  10  words  of  term2.  The
        threshold can be set like this:
 
           notmuch search term1 NEAR/2 term2
           notmuch search term1 ADJ term2
 
        will return results where term1 is within 10 words of term2, but in the
-       same  order  as in the query. The threshold can be set the same as with
+       same order as in the query. The threshold can be set the same  as  with
        NEAR:
 
           notmuch search term1 ADJ/7 term2
           notmuch search details
           notmuch search detail
 
-       will all return identical results, because Xapian first  &quot;reduces&quot;  the
+       will  all  return identical results, because Xapian first &quot;reduces&quot; the
        term to the common stem (here &apos;detail&apos;) and then performs the search.
 
-       There  are  two  ways to turn this off: a search for a capitalized word
-       will be performed unstemmed, so that one can search for &quot;John&quot; and  not
-       get  results  for  &quot;Johnson&quot;;  phrase  searches are also unstemmed (see
-       below for details).  Stemming is currently only supported for  English.
+       There are two ways to turn this off: a search for  a  capitalized  word
+       will  be performed unstemmed, so that one can search for &quot;John&quot; and not
+       get results for &quot;Johnson&quot;; phrase  searches  are  also  unstemmed  (see
+       below  for details).  Stemming is currently only supported for English.
        Searches for words in other languages will be performed unstemmed.
 </pre>
 
 <h3> &nbsp; Wildcards</h3>
 <pre>
-       It  is  possible  to  use  a  trailing  &apos;*&apos; as a wildcard. A search for
+       It is possible to use a trailing  &apos;*&apos;  as  a  wildcard.  A  search  for
        &apos;wildc*&apos; will match &apos;wildcard&apos;, &apos;wildcat&apos;, etc.
 </pre>
 
 <h3> &nbsp; Boolean and Probabilistic Prefixes</h3>
 <pre>
-       Xapian (and hence notmuch)  prefixes  are  either  <b>boolean</b>,  supporting
-       exact  matches  like  &quot;<u>tag:inbox</u>&quot;   or <b>probabilistic</b>, supporting a more
-       flexible <b>term</b> based searching. The prefixes currently supported by not‐
-       much are as follows.
+       Xapian  (and  hence  notmuch)  prefixes  are either <b>boolean</b>, supporting
+       exact matches like &quot;<u>tag:inbox</u>&quot;  or  <b>probabilistic</b>,  supporting  a  more
+       flexible  <b>term</b>  based searching. Certain <b>special</b> prefixes are processed
+       by notmuch in a way not stricly fitting either  of  Xapian&apos;s  built  in
+       styles. The prefixes currently supported by notmuch are as follows.
 
        <b>Boolean</b>
               <b>tag:</b>, <b>id:</b>, <b>thread:</b>, <b>folder:</b>, <b>path:</b>, <b>property:</b>
 
        <b>Probabilistic</b>
-              <b>from:</b>, <b>to:</b>, <b>subject:</b>, <b>attachment:</b>, <b>mimetype:</b>
+              <b>to:</b>, <b>attachment:</b>, <b>mimetype:</b>
+
+       <b>Special</b>
+              <b>from:</b>, <b>query:</b>, <b>subject:</b>
 </pre>
 
 <h3> &nbsp; Terms and phrases</h3>
        · non-range date queries, e.g. &quot;date:today&quot;
 
        · named queries e.g. &quot;query:my_special_query&quot;
+
+       · regular expression searches, e.g. &quot;subject:/^\[SPAM\]/&quot;
 </pre>
 
 <h2>SEE ALSO</h2>
 
 <h2>COPYRIGHT</h2>
 <pre>
-       2009-2016, Carl Worth and many others
+       2009-2017, Carl Worth and many others
 </pre>
 
-<h2>0.23.4</h2>
+<h2>0.24</h2>