schemata: Add documentation for JSON reply format.
authorAdam Wolfe Gordon <awg+notmuch@xvx.ca>
Sun, 18 Mar 2012 16:32:37 +0000 (10:32 -0600)
committerDavid Bremner <bremner@debian.org>
Tue, 20 Mar 2012 00:56:25 +0000 (21:56 -0300)
devel/schemata

index 24ad77571bc84685bd337e2e6fa8eb663c03bf0c..728a46f214ac5a1597c48a62f6d00efbd41ffcd6 100644 (file)
@@ -77,8 +77,9 @@ part = {
     content?:       string
 }
 
-# The headers of a message (format_headers_json with raw headers) or
-# a part (format_headers_message_part_json with pretty-printed headers)
+# The headers of a message (format_headers_json with raw headers
+# and reply = FALSE) or a part (format_headers_message_part_json
+# with pretty-printed headers)
 headers = {
     Subject:        string,
     From:           string,
@@ -136,3 +137,25 @@ thread = {
                               # matched and unmatched
     subject:        string
 }
+
+notmuch reply schema
+--------------------
+
+reply = {
+    # The headers of the constructed reply (format_headers_json with
+    # raw headers and reply = TRUE)
+    reply-headers: reply_headers,
+
+    # As in the show format (format_part_json)
+    original: message
+}
+
+reply_headers = {
+    Subject:        string,
+    From:           string,
+    To?:            string,
+    Cc?:            string,
+    Bcc?:           string,
+    In-reply-to:    string,
+    References:     string
+}