From 0412c3c1b0880c6e334185ba5639f90907a1b136 Mon Sep 17 00:00:00 2001 From: Justin Campbell Date: Thu, 15 Oct 2020 15:06:03 -0400 Subject: [PATCH] Update section parsing docs --- docs/Section Parsing Formatting.md | 57 +++++++++++++++++++++++++++--- 1 file changed, 52 insertions(+), 5 deletions(-) diff --git a/docs/Section Parsing Formatting.md b/docs/Section Parsing Formatting.md index fa276df..e4d016e 100644 --- a/docs/Section Parsing Formatting.md +++ b/docs/Section Parsing Formatting.md @@ -4,12 +4,40 @@ - [Introduction](#introduction) - [Directory Information](#directory-information) + - [Fields](#fields) + - [Delimiters](#delimiters) + - [Plain Text Example](#plain-text-example) + - [Parsed Example](#parsed-example) - [Initial Message](#initial-message) + - [Fields](#fields-1) + - [Delimiters](#delimiters-1) + - [Plain Text Example](#plain-text-example-1) + - [Parsed Example](#parsed-example-1) - [Edit](#edit) + - [Fields](#fields-2) + - [Delimiters](#delimiters-2) + - [Plain Text Example](#plain-text-example-2) + - [Parsed Example](#parsed-example-2) - [Status](#status) + - [Fields](#fields-3) + - [Delimiters](#delimiters-3) + - [Plain Text Example](#plain-text-example-3) + - [Parsed Example](#parsed-example-3) - [Assignment](#assignment) + - [Fields](#fields-4) + - [Delimiters](#delimiters-4) + - [Plain Text Example](#plain-text-example-4) + - [Parsed Example](#parsed-example-4) - [Reply To User](#reply-to-user) + - [Fields](#fields-5) + - [Delimiters](#delimiters-5) + - [Plain Text Example](#plain-text-example-5) + - [Parsed Example](#parsed-example-5) - [Reply from User](#reply-from-user) + - [Fields](#fields-6) + - [Delimiters:](#delimiters) + - [Plain Text Example](#plain-text-example-6) + - [Parsed Example](#parsed-example-6) @@ -83,11 +111,12 @@ The body of the email the item originated from. This usually appears directly af | - | - | | `type` | `initial_message` | | `datetime` | RFC 8061 formatted datetime string. | -| `from_name` | The sender's real name. Formatting may vary. This can be |empty. -| `from_email` | The sender's email address. | -| `to` | A list of names(s) and email(s) of people this message was sent |to. -| `cc` | A list of name(s) and email(s) of people who were CC'd. This can |be empty. -| `content` | The content of the message as an list of strings | +| `from_name` | The sender's real name. Formatting may vary. This can be empty. | +| `from_email` | The sender's email address. | +| `to` | A list of names(s) and email(s) of people this message was sent to. | +| `cc` | A list of name(s) and email(s) of people who were CC'd. This can be empty. | +| `subject` | The subject of the initial message. | +| `content` | The content of the message as an list of strings. | ### Delimiters - **Start**: First newline after directory information if present, otherwise first newline. @@ -111,6 +140,7 @@ I need some help with something. "cc": [ { "name": "", "email": "janesmith@example.com" } ], + "subject": Maps to item.subject, "content": [ "I need some help with something.\n" ] @@ -275,6 +305,8 @@ A message from the user and/or related parties. This is only found after two or | `from_name` | The sender's real name. Formatting may vary. This can be empty. | | `from_email` | The sender's email address. | | `cc` | A list of name(s) and email(s) of people who were CC'd. This can be empty. | +| `headers` | A dictionary of headers from the reply. | +| `subject` | The subject of the reply. | | `content` | The content of the message as an list of strings | ### Delimiters: @@ -308,6 +340,21 @@ Mike { "name": "John Doe", "email": "johndoe@example.com" }, { "name": "", "email": "janesmith@example.com" } ], + "headers" : [ + { + "type": "Subject", + "content": "RE: New Computer Deploy" + }, + { + "type": "From", + "content": "\"Reckowsky, Michael J.\" " + }, + { + "type": "Date", + "content": "Fri, 8 May 2020 13:57:17 +0000" + }, + ], + "subject": "RE: New Computer Deploy", "content": [ "Ethan,\n", "\n",