add property: query prefix to search for specific properties

We want to be able to query the properties directly, like:

   notmuch count property:foo=bar

which should return a count of messages where the property with key
"foo" has value equal to "bar".
This commit is contained in:
Daniel Kahn Gillmor 2016-07-08 11:15:36 +02:00 committed by David Bremner
parent 651da30c09
commit 693ca8d8a8
3 changed files with 23 additions and 2 deletions

View file

@ -58,6 +58,8 @@ indicate user-supplied values):
- query:<name> - query:<name>
- property:<key>=<value>
The **from:** prefix is used to match the name or address of the sender The **from:** prefix is used to match the name or address of the sender
of an email message. of an email message.
@ -139,6 +141,11 @@ queries added with **notmuch-config(1)**. Named queries are only
available if notmuch is built with **Xapian Field Processors** (see available if notmuch is built with **Xapian Field Processors** (see
below). below).
The **property:** 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.
Operators Operators
--------- ---------
@ -217,7 +224,7 @@ exact matches like "tag:inbox" or **probabilistic**, supporting a more flexible
Boolean Boolean
**tag:**, **id:**, **thread:**, **folder:**, **path:** **tag:**, **id:**, **thread:**, **folder:**, **path:**, **property:**
Probabilistic Probabilistic
**from:**, **to:**, **subject:**, **attachment:**, **mimetype:** **from:**, **to:**, **subject:**, **attachment:**, **mimetype:**

View file

@ -97,6 +97,9 @@ typedef struct {
* STRING is the name of a file within that * STRING is the name of a file within that
* directory for this mail message. * directory for this mail message.
* *
* property: Has a property with key=value
* FIXME: if no = is present, should match on any value
*
* A mail document also has four values: * A mail document also has four values:
* *
* TIMESTAMP: The time_t value corresponding to the message's * TIMESTAMP: The time_t value corresponding to the message's
@ -251,7 +254,6 @@ static prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
{ "directory", "XDIRECTORY" }, { "directory", "XDIRECTORY" },
{ "file-direntry", "XFDIRENTRY" }, { "file-direntry", "XFDIRENTRY" },
{ "directory-direntry", "XDDIRENTRY" }, { "directory-direntry", "XDDIRENTRY" },
{ "property", "XPROPERTY" },
}; };
static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = { static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
@ -260,6 +262,7 @@ static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
{ "is", "K" }, { "is", "K" },
{ "id", "Q" }, { "id", "Q" },
{ "path", "P" }, { "path", "P" },
{ "property", "XPROPERTY" },
/* /*
* Unconditionally add ':' to reduce potential ambiguity with * Unconditionally add ':' to reduce potential ambiguity with
* overlapping prefixes and/or terms that start with capital * overlapping prefixes and/or terms that start with capital

View file

@ -237,4 +237,15 @@ notmuch restore < BEFORE2
notmuch dump | grep '^#=' > OUTPUT notmuch dump | grep '^#=' > OUTPUT
test_expect_equal_file PROPERTIES OUTPUT test_expect_equal_file PROPERTIES OUTPUT
test_begin_subtest "test 'property:' queries: empty"
notmuch search property:testkey1=charles > OUTPUT
test_expect_equal_file /dev/null OUTPUT
test_begin_subtest "test 'property:' queries: single message"
notmuch search --output=messages property:testkey1=alice > OUTPUT
cat <<EOF >EXPECTED
id:4EFC743A.3060609@april.org
EOF
test_expect_equal_file EXPECTED OUTPUT
test_done test_done