X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=devel%2Fschemata;h=00ebb7a6e7148f9f7f2930de214e0e85ae915589;hb=5a69aa14748162429c43ad5ff3d8b35779fff0d4;hp=cdd0e433f6f442665fc1066f78bfafebe07ce3a2;hpb=ec630c663597cc3d6f4f98f9ec4ec17a6c7b5bbc;p=notmuch diff --git a/devel/schemata b/devel/schemata index cdd0e433..00ebb7a6 100644 --- a/devel/schemata +++ b/devel/schemata @@ -14,7 +14,21 @@ are interleaved. Keys are printed as keywords (symbols preceded by a 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 2 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. Common non-terminals -------------------- @@ -49,7 +63,7 @@ message = { # (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*], @@ -66,6 +80,7 @@ part = { sigstatus?: sigstatus, content-type: string, + content-disposition?: string, content-id?: string, # if content-type starts with "multipart/": content: [part*], @@ -145,7 +160,15 @@ thread_summary = { 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