1 This file describes the schemata used for notmuch's structured output
2 format (currently JSON and S-Expressions).
4 []'s indicate lists. List items can be marked with a '?', meaning
5 they are optional; or a '*', meaning there can be zero or more of that
6 item. {}'s indicate an object that maps from field identifiers to
7 values. An object field marked '?' is optional. |'s indicate
8 alternates (e.g., int|string means something can be an int or a
11 For S-Expression output, lists are printed delimited by () instead of
12 []. Objects are printed as p-lists, i.e. lists where the keys and values
13 are interleaved. Keys are printed as keywords (symbols preceded by a
14 colon), e.g. (:id "123" :time 54321 :from "foobar"). Null is printed as
15 nil, true as t and false as nil.
20 # Number of seconds since the Epoch
23 # Thread ID, sans "thread:"
26 # Message ID, sans "id:"
32 # A top-level set of threads (do_show)
33 # Returned by notmuch show without a --part argument
34 thread_set = [thread*]
36 # Top-level messages in a thread (show_messages)
37 thread = [thread_node*]
39 # A message and its replies (show_messages)
41 message|null, # null if not matched and not --entire-thread
42 [thread_node*] # children of message
45 # A message (format_part_sprinter)
47 # (format_message_sprinter)
51 timestamp: unix_time, # date header as unix time
52 date_relative: string, # user-friendly timestamp
56 body?: [part] # omitted if --body=false
59 # A MIME part (format_part_sprinter)
61 id: int|string, # part id (currently DFS part number)
63 encstatus?: encstatus,
64 sigstatus?: sigstatus,
68 # if content-type starts with "multipart/":
70 # if content-type is "message/rfc822":
71 content: [{headers: headers, body: [part]}],
72 # otherwise (leaf parts):
74 content-charset?: string,
75 # A leaf part's body content is optional, but may be included if
76 # it can be correctly encoded as a string. Consumers should use
77 # this in preference to fetching the part content separately.
81 # The headers of a message or part (format_headers_sprinter with reply = FALSE)
92 # Encryption status (format_part_sprinter)
93 encstatus = [{status: "good"|"bad"}]
95 # Signature status (format_part_sigstatus_sprinter)
96 sigstatus = [signature*]
99 # (signature_status_to_string)
100 status: "none"|"good"|"bad"|"error"|"unknown",
101 # if status is "good":
102 fingerprint?: string,
106 # if status is not "good":
108 # if the signature has errors:
112 notmuch search schema
113 ---------------------
119 threads = [threadid*]
122 messages = [messageid*]
132 timestamp: unix_time,
133 date_relative: string, # user-friendly timestamp
134 matched: int, # number of matched messages
135 total: int, # total messages in thread
136 authors: string, # comma-separated names with | between
137 # matched and unmatched
146 # The headers of the constructed reply
147 reply-headers: reply_headers,
149 # As in the show format (format_part_sprinter)
153 # Reply headers (format_headers_sprinter with reply = TRUE)