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; one marked with '*'
8 can repeat (with a different name). |'s indicate alternates (e.g.,
9 int|string means something can be an int or a string).
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.
17 This is version 5 of the structured output format.
23 - First versioned schema release.
24 - Added part.content-length and part.content-transfer-encoding fields.
27 - Added the thread_summary.query field.
30 - Replaced message.filename string with a list of filenames.
31 - Added part.content-disposition field.
34 - replace signature error integer bitmask with a set of flags for
36 - (notmuch 0.29) added message.crypto to identify overall message
40 - sorting support for notmuch show (no change to actual schema,
41 just new command line argument)
46 # Number of seconds since the Epoch
49 # Thread ID, sans "thread:"
52 # Message ID, sans "id:"
55 # E-mail header name, sans trailing colon, like "Subject" or "In-Reply-To"
61 # A top-level set of threads (do_show)
62 # Returned by notmuch show without a --part argument
63 thread_set = [thread*]
65 # Top-level messages in a thread (show_messages)
66 thread = [thread_node*]
68 # A message and its replies (show_messages)
70 message|null, # null if not matched and not --entire-thread
71 [thread_node*] # children of message
74 # A message (format_part_sprinter)
76 # (format_message_sprinter)
80 timestamp: unix_time, # date header as unix time
81 date_relative: string, # user-friendly timestamp
86 body?: [part] # omitted if --body=false
89 # when showing the message, was any or all of it decrypted?
90 msgdecstatus: "full"|"partial"
92 # The overall cryptographic state of the message as a whole:
96 # was the set of signatures described under encrypted cover?
98 # which of the headers is covered by sigstatus?
99 headers: [header_name*]
102 status: msgdecstatus,
103 # map encrypted headers that differed from the outside headers.
104 # the value of each item in the map is what that field showed externally
105 # (maybe null if it was not present in the external headers).
106 header-mask: { header_name*: string|null }
110 # A MIME part (format_part_sprinter)
112 id: int|string, # part id (currently DFS part number)
114 encstatus?: encstatus,
115 sigstatus?: sigstatus,
117 content-type: string,
118 content-disposition?: string,
120 # if content-type starts with "multipart/":
122 # if content-type is "message/rfc822":
123 content: [{headers: headers, body: [part]}],
124 # otherwise (leaf parts):
126 content-charset?: string,
127 # A leaf part's body content is optional, but may be included if
128 # it can be correctly encoded as a string. Consumers should use
129 # this in preference to fetching the part content separately.
131 # If a leaf part's body content is not included, the length of
132 # the encoded content (in bytes) may be given instead.
133 content-length?: int,
134 # If a leaf part's body content is not included, its transfer encoding
135 # may be given. Using this and the encoded content length, it is
136 # possible for the consumer to estimate the decoded content length.
137 content-transfer-encoding?: string
140 # The headers of a message or part (format_headers_sprinter with reply = FALSE)
151 # Encryption status (format_part_sprinter)
152 encstatus = [{status: "good"|"bad"}]
154 # Signature status (format_part_sigstatus_sprinter)
155 sigstatus = [signature*]
158 # (signature_status_to_string)
159 status: "good"|"bad"|"error"|"unknown",
160 # if status is "good":
161 fingerprint?: string,
166 # if status is not "good":
176 alg-unsupported?: bool,
184 notmuch search schema
185 ---------------------
188 search_summary = [thread_summary*]
191 search_threads = [threadid*]
194 search_messages = [messageid*]
197 search_files = [string*]
200 search_tags = [string*]
204 timestamp: unix_time,
205 date_relative: string, # user-friendly timestamp
206 matched: int, # number of matched messages
207 total: int, # total messages in thread
208 authors: string, # comma-separated names with | between
209 # matched and unmatched
213 # Two stable query strings identifying exactly the matched and
214 # unmatched messages currently in this thread. The messages
215 # matched by these queries will not change even if more messages
216 # arrive in the thread. If there are no matched or unmatched
217 # messages, the corresponding query will be null (there is no
218 # query that matches nothing). (Added in schema version 2.)
219 query: [string|null, string|null],
226 # The headers of the constructed reply
227 reply-headers: reply_headers,
229 # As in the show format (format_part_sprinter)
233 # Reply headers (format_headers_sprinter with reply = TRUE)