colon), e.g. (:id "123" :time 54321 :from "foobar"). Null is printed as
nil, true as t and false as nil.
-This is version 1 of the structured output format.
+This is version 4 of the structured output format.
+
+Version history
+---------------
+
+v1
+- First versioned schema release.
+- Added part.content-length and part.content-transfer-encoding fields.
+
+v2
+- Added the thread_summary.query field.
+
+v3
+- Replaced message.filename string with a list of filenames.
+- Added part.content-disposition field.
+
+v4
+- replace signature error integer bitmask with a set of flags for
+ individual errors.
+- (notmuch 0.29) added message.crypto to identify overall message
+ cryptographic state
Common non-terminals
--------------------
# (format_message_sprinter)
id: messageid,
match: bool,
- filename: string,
+ filename: [string*],
timestamp: unix_time, # date header as unix time
date_relative: string, # user-friendly timestamp
tags: [string*],
headers: headers,
+ crypto: crypto,
body?: [part] # omitted if --body=false
}
+# when showing the message, was any or all of it decrypted?
+msgdecstatus: "full"|"partial"
+
+# The overall cryptographic state of the message as a whole:
+crypto = {
+ signed?: {
+ status: sigstatus,
+ # was the set of signatures described under encrypted cover?
+ encrypted: bool,
+ },
+ decrypted?: {
+ status: msgdecstatus,
+ }
+}
+
# A MIME part (format_part_sprinter)
part = {
id: int|string, # part id (currently DFS part number)
sigstatus?: sigstatus,
content-type: string,
+ content-disposition?: string,
content-id?: string,
# if content-type starts with "multipart/":
content: [part*],
signature = {
# (signature_status_to_string)
- status: "none"|"good"|"bad"|"error"|"unknown",
+ status: "good"|"bad"|"error"|"unknown",
# if status is "good":
fingerprint?: string,
created?: unix_time,
userid?: string
# if status is not "good":
keyid?: string
- # if the signature has errors:
- errors?: int
+ errors?: sig_errors
+}
+
+sig_errors = {
+ key-revoked?: bool,
+ key-expired?: bool,
+ sig-expired?: bool,
+ key-missing?: bool,
+ alg-unsupported?: bool,
+ crl-missing?: bool,
+ crl-too-old?: bool,
+ bad-policy?: bool,
+ sys-error?: bool,
+ tofu-conflict?: bool
}
notmuch search schema
---------------------
# --output=summary
-summary = [thread*]
+search_summary = [thread_summary*]
# --output=threads
-threads = [threadid*]
+search_threads = [threadid*]
# --output=messages
-messages = [messageid*]
+search_messages = [messageid*]
# --output=files
-files = [string*]
+search_files = [string*]
# --output=tags
-tags = [string*]
+search_tags = [string*]
-thread = {
+thread_summary = {
thread: threadid,
timestamp: unix_time,
date_relative: string, # user-friendly timestamp
authors: string, # comma-separated names with | between
# matched and unmatched
subject: string,
- tags: [string*]
+ tags: [string*],
+
+ # Two stable query strings identifying exactly the matched and
+ # unmatched messages currently in this thread. The messages
+ # matched by these queries will not change even if more messages
+ # arrive in the thread. If there are no matched or unmatched
+ # messages, the corresponding query will be null (there is no
+ # query that matches nothing). (Added in schema version 2.)
+ query: [string|null, string|null],
}
notmuch reply schema