1 This file describes the schemata used for notmuch's structured output
2 format (currently JSON).
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
14 # Number of seconds since the Epoch
17 # Thread ID, sans "thread:"
20 # Message ID, sans "id:"
26 # A top-level set of threads (do_show)
27 # Returned by notmuch show without a --part argument
28 thread_set = [thread*]
30 # Top-level messages in a thread (show_messages)
31 thread = [thread_node*]
33 # A message and its replies (show_messages)
35 message?, # present if --entire-thread or matched
36 [thread_node*] # children of message
39 # A message (show_message)
41 # (format_message_json)
45 timestamp: unix_time, # date header as unix time
46 date_relative: string, # user-friendly timestamp
53 # A MIME part (show_message_body)
55 # format_part_start_json
56 id: int|string, # part id (currently DFS part number)
58 # format_part_encstatus_json
59 encstatus?: encstatus,
61 # format_part_sigstatus_json
62 sigstatus?: sigstatus,
64 # format_part_content_json
67 # if content-type starts with "multipart/":
69 # if content-type is "message/rfc822":
70 content: [{headers: headers, body: [part]}],
71 # otherwise (leaf parts):
73 content-charset?: string,
74 # A leaf part's body content is optional, but may be included if
75 # it can be correctly encoded as a string. Consumers should use
76 # this in preference to fetching the part content separately.
80 # The headers of a message (format_headers_json with raw headers
81 # and reply = FALSE) or a part (format_headers_message_part_json
82 # with pretty-printed headers)
92 # Encryption status (format_part_encstatus_json)
93 encstatus = [{status: "good"|"bad"}]
95 # Signature status (format_part_sigstatus_json)
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
145 # The headers of the constructed reply (format_headers_json with
146 # raw headers and reply = TRUE)
147 reply-headers: reply_headers,
149 # As in the show format (format_part_json)