summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/report-tree42
1 files changed, 42 insertions, 0 deletions
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']