notmuch-search(1) [debian man page]

NOTMUCH-SEARCH(1)					      General Commands Manual						 NOTMUCH-SEARCH(1)

NAME

       notmuch-search - Search for messages matching the given search terms.

SYNOPSIS

       notmuch search [options...] <search-term>...

DESCRIPTION

       Search for messages matching the given search terms, and display as results the threads containing the matched messages.

       The  output  consists  of one line per thread, giving a thread ID, the date of the newest (or oldest, depending on the sort option) matched
       message in the thread, the number of matched messages and total messages in the thread, the names of all participants in  the  thread,  and
       the subject of the newest (or oldest) message.

       See notmuch-search-terms(7) for details of the supported syntax for <search-terms>.

       Supported options for search include

	   --format=(json|text)

	       Presents the results in either JSON or plain-text (default).

	   --output=(summary|threads|messages|files|tags)

	       summary

		   Output  a summary of each thread with any message matching the search terms. The summary includes the thread ID, date, the num-
		   ber of messages in the thread (both the number matched and the total number), the authors of the thread and the subject.

	       threads

		   Output the thread IDs of all threads with any message matching the search terms, either one per line (--format=text)  or  as  a
		   JSON array (--format=json).

	       messages

		   Output  the	message  IDs  of  all  messages  matching the search terms, either one per line (--format=text) or as a JSON array
		   (--format=json).

	       files

		   Output the filenames of all messages matching the search terms, either one per line (--format=text) or as a JSON array  (--for-
		   mat=json).

	       tags

		   Output  all	tags  that appear on any message matching the search terms, either one per line (--format=text) or as a JSON array
		   (--format=json).

	   --sort=(newest-first|oldest-first)

	       This option can be used to present results in either chronological  order  (oldest-first)  or  reverse  chronological  order  (new-
	       est-first).

	       Note:  The thread order will be distinct between these two options (beyond being simply reversed). When sorting by oldest-first the
	       threads will be sorted by the oldest message in each thread, but when sorting by newest-first the threads will  be  sorted  by  the
	       newest message in each thread.

	       By default, results will be displayed in reverse chronological order, (that is, the newest results will be displayed first).

	   --offset=[-]N

	       Skip displaying the first N results. With the leading '-', start at the Nth result from the end.

	   --limit=N

	       Limit the number of displayed results to N.

	   --exclude=(true|false|flag)

	       Specify	whether  to  omit messages matching search.tag_exclude from the search results (the default) or not. The extra option flag
	       only has an effect when --output=summary In this case all matching threads are returned but the "match  count"  is  the	number	of
	       matching non-excluded messages in the thread.

SEE ALSO

       notmuch(1),  notmuch-config(1),	notmuch-count(1), notmuch-dump(1), notmuch-hooks(5), notmuch-new(1), notmuch-reply(1), notmuch-restore(1),
       notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1)

Notmuch 0.13.2							    2012-06-01							 NOTMUCH-SEARCH(1)

NOTMUCH-SEARCH-TERMS(7) 				 Miscellaneous Information Manual				   NOTMUCH-SEARCH-TERMS(7)

NAME

       notmuch-search-terms - Syntax for notmuch queries

SYNOPSIS

       notmuch count [options...]  <search-term>...

       notmuch dump [ <filename> ] [--] [ <search-term>...]

       notmuch search [options...] <search-term>...

       notmuch show [options...] <search-term>...

       notmuch tag +<tag>|-<tag> [...] [--] <search-term>...

DESCRIPTION

       Several notmuch commands accept a common syntax for search terms.

       The  search  terms  can	consist  of  free-form	text  (and  quoted  phrases)  which  will match all messages that contain all of the given
       terms/phrases in the body, the subject, or any of the sender or recipient headers.

       As a special case, a search string consisting of exactly a single asterisk ("*") will match all messages.

       In addition to free text, the following prefixes can be used to force terms to match against specific portions of an email, (where  <brack-
       ets> indicate user-supplied values):

	    from:<name-or-address>

	    to:<name-or-address>

	    subject:<word-or-quoted-phrase>

	    attachment:<word>

	    tag:<tag> (or is:<tag>)

	    id:<message-id>

	    thread:<thread-id>

	    folder:<directory-path>

       The from: prefix is used to match the name or address of the sender of an email message.

       The to: prefix is used to match the names or addresses of any recipient of an email message, (whether To, Cc, or Bcc).

       Any  term  prefixed  with subject: will match only text from the subject of an email. Searching for a phrase in the subject is supported by
       including quotation marks around the phrase, immediately following subject:.

       The attachment: prefix can be used to search for specific filenames (or extensions) of attachments to email messages.

       For tag: and is: valid tag values include inbox and unread by default for new messages added by notmuch new as well as any other tag values
       added manually with notmuch tag.

       For id:, message ID values are the literal contents of the Message-ID: header of email messages, but without the '<', '>' delimiters.

       The  thread:  prefix  can be used with the thread ID values that are generated internally by notmuch (and do not appear in email messages).
       These thread ID values can be seen in the first column of output from notmuch search

       The folder: prefix can be used to search for email message files that are contained within particular directories within  the  mail  store.
       Only the directory components below the top-level mail database path are available to be searched.

       In  addition to individual terms, multiple terms can be combined with Boolean operators ( and, or, not , etc.). 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 until we get Xapian defect #402 fixed).

       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).

       Finally, results can be restricted to only messages within a particular time range, (based on the Date: header) with a syntax of:

	    <initial-timestamp>..<final-timestamp>

       Each timestamp is a number representing the number of seconds since 1970-01-01 00:00:00 UTC. This is  not  the  most  convenient  means	of
       expressing  date ranges, but until notmuch is fixed to accept a more convenient form, one can use the date program to construct timestamps.
       For example, with the bash shell the following syntax would specify a date range to return messages from 2009-10-01 until the current time:

	    $(date +%s -d 2009-10-01)..$(date +%s)

SEE ALSO

       notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5), notmuch-new(1),  notmuch-reply(1),  notmuch-restore(1),
       notmuch-search(1), notmuch-show(1), notmuch-tag(1)

Notmuch 0.13.2							    2012-06-01						   NOTMUCH-SEARCH-TERMS(7)