diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst index 075f88c8..de93d733 100644 --- a/doc/man7/notmuch-search-terms.rst +++ b/doc/man7/notmuch-search-terms.rst @@ -58,6 +58,8 @@ indicate user-supplied values): - query: +- property:= + The **from:** prefix is used to match the name or address of the sender 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 below). +The **property:** prefix searches for messages with a particular += 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 --------- @@ -217,7 +224,7 @@ exact matches like "tag:inbox" or **probabilistic**, supporting a more flexible Boolean - **tag:**, **id:**, **thread:**, **folder:**, **path:** + **tag:**, **id:**, **thread:**, **folder:**, **path:**, **property:** Probabilistic **from:**, **to:**, **subject:**, **attachment:**, **mimetype:** diff --git a/lib/database.cc b/lib/database.cc index 33e22d86..392e8b28 100644 --- a/lib/database.cc +++ b/lib/database.cc @@ -97,6 +97,9 @@ typedef struct { * STRING is the name of a file within that * 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: * * TIMESTAMP: The time_t value corresponding to the message's @@ -251,7 +254,6 @@ static prefix_t BOOLEAN_PREFIX_INTERNAL[] = { { "directory", "XDIRECTORY" }, { "file-direntry", "XFDIRENTRY" }, { "directory-direntry", "XDDIRENTRY" }, - { "property", "XPROPERTY" }, }; static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = { @@ -260,6 +262,7 @@ static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = { { "is", "K" }, { "id", "Q" }, { "path", "P" }, + { "property", "XPROPERTY" }, /* * Unconditionally add ':' to reduce potential ambiguity with * overlapping prefixes and/or terms that start with capital diff --git a/test/T610-message-property.sh b/test/T610-message-property.sh index c92b99ba..65ff19dc 100755 --- a/test/T610-message-property.sh +++ b/test/T610-message-property.sh @@ -237,4 +237,15 @@ notmuch restore < BEFORE2 notmuch dump | grep '^#=' > 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 <EXPECTED +id:4EFC743A.3060609@april.org +EOF +test_expect_equal_file EXPECTED OUTPUT + test_done