--- /dev/null
+<h1>NOTMUCH-EMACS-MUA(1)</h1>
+
+<h2>NAME</h2>
+<pre>
+ notmuch-emacs-mua - send mail with notmuch and emacs
+</pre>
+
+<h2>SYNOPSIS</h2>
+<pre>
+ <b>notmuch</b> <b>emacs-mua</b> [options ...] [<to-address> ... | <mailto-url>]
+</pre>
+
+<h2>DESCRIPTION</h2>
+<pre>
+ Start composing an email in the Notmuch Emacs UI with the specified
+ subject, recipients, and message body, or mailto: URL.
+
+ Supported options for <b>emacs-mua</b> include
+
+ <b>-h,</b> <b>--help</b>
+ Display help.
+
+ <b>-s,</b> <b>--subject=<subject></b>
+ Specify the subject of the message.
+
+ <b>--to=<to-address></b>
+ Specify a recipient (To).
+
+ <b>-c,</b> <b>--cc=<cc-address></b>
+ Specify a carbon-copy (Cc) recipient.
+
+ <b>-b,</b> <b>--bcc=<bcc-address></b>
+ Specify a blind-carbon-copy (Bcc) recipient.
+
+ <b>-i,</b> <b>--body=<file></b>
+ Specify a file to include into the body of the message.
+
+ <b>--hello</b>
+ Go to the Notmuch hello screen instead of the message compo‐
+ sition window if no message composition parameters are given.
+
+ <b>--no-window-system</b>
+ Even if a window system is available, use the current termi‐
+ nal.
+
+ <b>--client</b>
+ Use <b>emacsclient</b>, rather than <b>emacs</b>. For <b>emacsclient</b> to work,
+ you need an already running Emacs with a server, or use
+ <b>--auto-daemon</b>.
+
+ <b>--auto-daemon</b>
+ Automatically start Emacs in daemon mode, if the Emacs server
+ is not running. Applicable with <b>--client</b>. Implies <b>--cre-</b>
+ <b>ate-frame</b>.
+
+ <b>--create-frame</b>
+ Create a new frame instead of trying to use the current Emacs
+ frame. Applicable with <b>--client</b>. This will be required when
+ Emacs is running (or automatically started with <b>--auto-dae-</b>
+ <b>mon</b>) in daemon mode.
+
+ <b>--print</b>
+ Output the resulting elisp to stdout instead of evaluating
+ it.
+
+ The supported positional parameters and short options are a compatible
+ subset of the <b>mutt</b> MUA command-line options. The options and positional
+ parameters modifying the message can't be combined with the mailto:
+ URL.
+
+ Options may be specified multiple times.
+</pre>
+
+<h2>ENVIRONMENT VARIABLES</h2>
+<pre>
+ <b>EMACS</b> Name of emacs command to invoke. Defaults to "emacs".
+
+ <b>EMACSCLIENT</b>
+ Name of emacsclient command to invoke. Defaults to "emac‐
+ sclient".
+</pre>
+
+<h2>SEE ALSO</h2>
+<pre>
+ <a href='../notmuch-1/'>notmuch</a>(1), <b>emacsclient</b>(1), <b>mutt</b>(1)
+</pre>
+
+<h2>AUTHOR</h2>
+<pre>
+ Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+ 2009-2017, Carl Worth and many others
+</pre>
+
+<h2>0.24</h2>
· 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 'from:/bob@.*[.]example[.]com/'
+
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 '<', '>' 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
- "/**" suffix can be used to match messages in the specified directory
- and all its subdirectories recursively. <b>path:""</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
+ "/**" suffix can be used to match messages in the specified directory
+ and all its subdirectories recursively. <b>path:""</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 "new" and "cur" subdirectories. The exact syn‐
- tax for maildir folders depends on your mail configuration. For
- maildir++, <b>folder:""</b> matches the inbox folder (which is the root in
- maildir++), other folder names always start with ".", and nested fold‐
- ers are separated by "."s, such as <b>folder:.classes.topology</b>. For "file
+ tax for maildir folders depends on your mail configuration. For
+ maildir++, <b>folder:""</b> matches the inbox folder (which is the root in
+ maildir++), other folder names always start with ".", and nested fold‐
+ ers are separated by "."s, such as <b>folder:.classes.topology</b>. For "file
system" 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:
<initial-timestamp>..<final-timestamp>
- 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
- <key>=<value> 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
+ <key>=<value> 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> 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 '-<term>' can be used for '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 '-<term>' can be used for 'not
<term>' 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 "reduces" the
+ will all return identical results, because Xapian first "reduces" the
term to the common stem (here 'detail') 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 "John" and not
- get results for "Johnson"; 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 "John" and not
+ get results for "Johnson"; 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> Wildcards</h3>
<pre>
- It is possible to use a trailing '*' as a wildcard. A search for
+ It is possible to use a trailing '*' as a wildcard. A search for
'wildc*' will match 'wildcard', 'wildcat', etc.
</pre>
<h3> Boolean and Probabilistic Prefixes</h3>
<pre>
- Xapian (and hence notmuch) prefixes are either <b>boolean</b>, supporting
- exact matches like "<u>tag:inbox</u>" 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 "<u>tag:inbox</u>" 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'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> Terms and phrases</h3>
· non-range date queries, e.g. "date:today"
· named queries e.g. "query:my_special_query"
+
+ · regular expression searches, e.g. "subject:/^\[SPAM\]/"
</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>
projects / notmuch-wiki / commitdiff