.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "NOTMUCH-PROPERTIES" "7" "Oct 03, 2024" "0.38.3" "notmuch"
.SH NAME
notmuch-properties \- notmuch message property conventions and documentation
.SH SYNOPSIS
.sp
\fBnotmuch\fP \fBcount\fP \fBproperty:\fP<\fIkey\fP>=<\fIvalue\fP>
.sp
\fBnotmuch\fP \fBsearch\fP \fBproperty:\fP<\fIkey\fP>=<\fIvalue\fP>
.sp
\fBnotmuch\fP \fBshow\fP \fBproperty:\fP<\fIkey\fP>=<\fIvalue\fP>
.sp
\fBnotmuch\fP \fBreindex\fP \fBproperty:\fP<\fIkey\fP>=<\fIvalue\fP>
.sp
\fBnotmuch\fP \fBtag\fP +<\fItag\fP> \fBproperty:\fP<\fIkey\fP>=<\fIvalue\fP>
.sp
\fBnotmuch\fP \fBdump\fP \fB\-\-include=properties\fP
.sp
\fBnotmuch\fP \fBrestore\fP \fB\-\-include=properties\fP
.SH DESCRIPTION
.sp
Several notmuch commands can search for, modify, add or remove
properties associated with specific messages.  Properties are
key/value pairs, and a message can have more than one key/value pair
for the same key.
.sp
While users can select based on a specific property in their search
terms with the prefix \fBproperty:\fP, the notmuch command\-line
interface does not provide mechanisms for modifying properties
directly to the user.
.sp
Instead, message properties are expected to be set and used
programmatically, according to logic in notmuch itself, or in
extensions to it.
.sp
Extensions to notmuch which make use of properties are encouraged to
report the specific properties used to the upstream notmuch project,
as a way of avoiding collisions in the property namespace.
.SH CONVENTIONS
.sp
Any property with a key that starts with \(dqindex.\(dq will be removed (and
possibly re\-set) upon reindexing (see \fI\%notmuch\-reindex\fP).
.SH MESSAGE PROPERTIES
.sp
The following properties are set by notmuch internally in the course
of its normal activity.
.INDENT 0.0
.TP
.B index.decryption
If a message contains encrypted content, and notmuch tries to
decrypt that content during indexing, it will add the property
\fBindex.decryption=success\fP when the cleartext was successfully
indexed.  If notmuch attempts to decrypt any part of a message
during indexing and that decryption attempt fails, it will add the
property \fBindex.decryption=failure\fP to the message.
.sp
Note that it\(aqs possible for a single message to have both
\fBindex.decryption=success\fP and \fBindex.decryption=failure\fP\&.
Consider an encrypted e\-mail message that contains another
encrypted e\-mail message as an attachment \-\- if the outer message
can be decrypted, but the attached part cannot, then both
properties will be set on the message as a whole.
.sp
If notmuch never tried to decrypt an encrypted message during
indexing (which is the default, see \fBindex.decrypt\fP in
\fI\%notmuch\-config\fP), then this property will not be set on that
message.
.TP
.B session\-key
When \fI\%notmuch\-show\fP or \fI\%notmuch\-reply\fP encounters
a message with an encrypted part, if notmuch finds a
\fBsession\-key\fP property associated with the message, it will try
that stashed session key for decryption.
.sp
If you do not want to use any stashed session keys that might be
present, you should pass those programs \fB\-\-decrypt=false\fP\&.
.sp
Using a stashed session key with \(dqnotmuch show\(dq will speed up
rendering of long encrypted threads.  It also allows the user to
destroy the secret part of any expired encryption\-capable subkey
while still being able to read any retained messages for which
they have stashed the session key.  This enables truly deletable
e\-mail, since (once the session key and asymmetric subkey are both
destroyed) there are no keys left that can be used to decrypt any
copy of the original message previously stored by an adversary.
.sp
However, access to the stashed session key for an encrypted message
permits full byte\-for\-byte reconstruction of the cleartext
message.  This includes attachments, cryptographic signatures, and
other material that cannot be reconstructed from the index alone.
.sp
See \fBindex.decrypt\fP in \fI\%notmuch\-config\fP for more
details about how to set notmuch\(aqs policy on when to store session
keys.
.sp
The session key should be in the ASCII text form produced by
GnuPG.  For OpenPGP, that consists of a decimal representation of
the hash algorithm used (identified by number from RFC 4880,
e.g. 9 means AES\-256) followed by a colon, followed by a
hexadecimal representation of the algorithm\-specific key.  For
example, an AES\-128 key might be stashed in a notmuch property as:
\fBsession\-key=7:14B16AF65536C28AF209828DFE34C9E0\fP\&.
.TP
.B index.repaired
Some messages arrive in forms that are confusing to view; they can
be mangled by mail transport agents, or the sending mail user
agent may structure them in a way that is confusing.  If notmuch
knows how to both detect and repair such a problematic message, it
will do so during indexing.
.sp
If it applies a message repair during indexing, it will use the
\fBindex.repaired\fP property to note the type of repair(s) it
performed.
.sp
\fBindex.repaired=skip\-protected\-headers\-legacy\-display\fP indicates
that when indexing the cleartext of an encrypted message, notmuch
skipped over a \(dqlegacy\-display\(dq text/rfc822\-headers part that it
found in that message, since it was able to index the built\-in
protected headers directly.
.sp
\fBindex.repaired=mixedup\fP indicates the repair of a \(dqMixed Up\(dq
encrypted PGP/MIME message, a mangling typically produced by
Microsoft\(aqs Exchange MTA.  See
\X'tty: link https://tools.ietf.org/html/draft-dkg-openpgp-pgpmime-message-mangling'\fI\%https://tools.ietf.org/html/draft\-dkg\-openpgp\-pgpmime\-message\-mangling\fP\X'tty: link'
for more information.
.UNINDENT
.SH SEE ALSO
.sp
\fI\%notmuch\fP,
\fI\%notmuch\-config\fP,
\fI\%notmuch\-dump\fP,
\fI\%notmuch\-insert\fP,
\fI\%notmuch\-new\fP,
\fI\%notmuch\-reindex\fP,
\fI\%notmuch\-reply\fP,
\fI\%notmuch\-restore\fP,
\fI\%notmuch\-search\-terms\fP,
\fI\%notmuch\-show\fP
.SH AUTHOR
Carl Worth and many others
.SH COPYRIGHT
2009-2024, Carl Worth and many others
.\" Generated by docutils manpage writer.
.