From bea0d7b07ab7f073818896cfb59721859034a93c Mon Sep 17 00:00:00 2001
From: Tomasz Kramkowski <tk@the-tk.com>
Date: Sun, 9 Apr 2017 20:44:57 +0200
Subject: docs: add some documentation

---
 docs/report-tree | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 docs/report-tree

(limited to 'docs')

diff --git a/docs/report-tree b/docs/report-tree
new file mode 100644
index 0000000..73d60b8
--- /dev/null
+++ b/docs/report-tree
@@ -0,0 +1,42 @@
+feedback
+|`-report_metadata
+|  |`-org_name @string
+|  |`-email @string
+|  |`-extra_contact_info? @string
+|  |`-report_id @string
+|  |`-date_range
+|  |  |`-begin @integer
+|  |   `-end @integer
+|   `-error* @string
+|`-policy_published
+|  |`-domain @string
+|  |`-adkim @enum['r', 's']
+|  |`-aspf @enum['r', 's']
+|  |`-p @enum:disposition['none', 'quarantine', 'reject']
+|  |`-sp @enum:disposition
+|   `-pct @integer
+ `-record+
+   |`-row
+   |  |`-source_ip @string/((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])|([A-Fa-f0-9]{1,4}:){7}[A-Fa-f0-9]{1,4}/
+   |  |`-count @integer
+   |   `-policy_evaluated?
+   |     |`-disposition @enum:disposition
+   |     |`-dkim @enum:dmarcresult['pass', 'fail']
+   |     |`-spf @enum:dmarcresult
+   |      `-reason*
+   |        |`-type @enum['forwarded', 'sampled_out', 'trusted_forwarder',
+   |        |             'mailing_list', 'local_policy', 'other']
+   |         `-comment? @string
+   |`-identifiers
+   |  |`-envelope_to? @string
+   |   `-header_from @string
+    `-auth_results
+      |`-dkim*
+      |  |`-domain @string
+      |  |`-result @enum['none', 'pass', 'fail', 'policy', 'neutral',
+      |  |               'temperror', 'permerror']
+      |   `-human_result? @string
+       `-spf+
+         |`-domain @string
+          `-result @enum['none', 'neutral', 'pass', 'fail', 'softfail',
+                         'temperror', 'permerror']
-- 
cgit v1.2.3-54-g00ecf