Update docs

2026-07-05 16:25:09 +00:00 · 2025-12-25 17:27:32 -05:00
parent ef1d001c16
commit f2545ed65c
9 changed files with 668 additions and 24 deletions
@@ -82,6 +82,7 @@
 <ul><li><a href="parsedmarc/elastic.html">parsedmarc.elastic</a></li>
 <li><a href="parsedmarc/opensearch.html">parsedmarc.opensearch</a></li>
 <li><a href="parsedmarc/splunk.html">parsedmarc.splunk</a></li>
+<li><a href="parsedmarc/types.html">parsedmarc.types</a></li>
 <li><a href="parsedmarc/utils.html">parsedmarc.utils</a></li>
 </ul></ul>

@@ -0,0 +1,404 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>parsedmarc.types &mdash; parsedmarc 9.0.6 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
+      <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
+
+  
+      <script src="../../_static/jquery.js?v=5d32c60e"></script>
+      <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+      <script src="../../_static/documentation_options.js?v=64e2c0d8"></script>
+      <script src="../../_static/doctools.js?v=9bcbadda"></script>
+      <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../../genindex.html" />
+    <link rel="search" title="Search" href="../../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+          
+          
+          <a href="../../index.html" class="icon icon-home">
+            parsedmarc
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../usage.html">Using parsedmarc</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../output.html">Sample outputs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../elasticsearch.html">Elasticsearch and Kibana</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../opensearch.html">OpenSearch and Grafana</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../kibana.html">Using the Kibana dashboards</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../splunk.html">Splunk</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../davmail.html">Accessing an inbox using OWA/EWS</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../dmarc.html">Understanding DMARC</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing to parsedmarc</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../api.html">API reference</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../index.html">parsedmarc</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../index.html">Module code</a></li>
+          <li class="breadcrumb-item"><a href="../parsedmarc.html">parsedmarc</a></li>
+      <li class="breadcrumb-item active">parsedmarc.types</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+             
+  <h1>Source code for parsedmarc.types</h1><div class="highlight"><pre>
+<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
+
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Literal</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">TypedDict</span><span class="p">,</span> <span class="n">Union</span>
+
+<span class="c1"># NOTE: This module is intentionally Python 3.9 compatible.</span>
+<span class="c1"># - No PEP 604 unions (A | B)</span>
+<span class="c1"># - No typing.NotRequired / Required (3.11+) to avoid an extra dependency.</span>
+<span class="c1">#   For optional keys, use total=False TypedDicts.</span>
+
+
+<span class="n">ReportType</span> <span class="o">=</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;aggregate&quot;</span><span class="p">,</span> <span class="s2">&quot;forensic&quot;</span><span class="p">,</span> <span class="s2">&quot;smtp_tls&quot;</span><span class="p">]</span>
+
+
+<div class="viewcode-block" id="AggregateReportMetadata">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.AggregateReportMetadata">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">AggregateReportMetadata</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">org_name</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">org_email</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">org_extra_contact_info</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">report_id</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">begin_date</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">end_date</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">timespan_requires_normalization</span><span class="p">:</span> <span class="nb">bool</span>
+    <span class="n">original_timespan_seconds</span><span class="p">:</span> <span class="nb">int</span>
+    <span class="n">errors</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span></div>
+
+
+
+<div class="viewcode-block" id="AggregatePolicyPublished">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.AggregatePolicyPublished">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">AggregatePolicyPublished</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">domain</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">adkim</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">aspf</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">p</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">sp</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">pct</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">fo</span><span class="p">:</span> <span class="nb">str</span></div>
+
+
+
+<div class="viewcode-block" id="IPSourceInfo">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.IPSourceInfo">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">IPSourceInfo</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">ip_address</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">country</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">reverse_dns</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">base_domain</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="nb">type</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span></div>
+
+
+
+<div class="viewcode-block" id="AggregateAlignment">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.AggregateAlignment">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">AggregateAlignment</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">spf</span><span class="p">:</span> <span class="nb">bool</span>
+    <span class="n">dkim</span><span class="p">:</span> <span class="nb">bool</span>
+    <span class="n">dmarc</span><span class="p">:</span> <span class="nb">bool</span></div>
+
+
+
+<div class="viewcode-block" id="AggregateIdentifiers">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.AggregateIdentifiers">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">AggregateIdentifiers</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">header_from</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">envelope_from</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">envelope_to</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span></div>
+
+
+
+<div class="viewcode-block" id="AggregatePolicyOverrideReason">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.AggregatePolicyOverrideReason">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">AggregatePolicyOverrideReason</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="nb">type</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">comment</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span></div>
+
+
+
+<div class="viewcode-block" id="AggregateAuthResultDKIM">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.AggregateAuthResultDKIM">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">AggregateAuthResultDKIM</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">domain</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">result</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">selector</span><span class="p">:</span> <span class="nb">str</span></div>
+
+
+
+<div class="viewcode-block" id="AggregateAuthResultSPF">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.AggregateAuthResultSPF">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">AggregateAuthResultSPF</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">domain</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">result</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">scope</span><span class="p">:</span> <span class="nb">str</span></div>
+
+
+
+<div class="viewcode-block" id="AggregateAuthResults">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.AggregateAuthResults">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">AggregateAuthResults</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">dkim</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">AggregateAuthResultDKIM</span><span class="p">]</span>
+    <span class="n">spf</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">AggregateAuthResultSPF</span><span class="p">]</span></div>
+
+
+
+<div class="viewcode-block" id="AggregatePolicyEvaluated">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.AggregatePolicyEvaluated">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">AggregatePolicyEvaluated</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">disposition</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">dkim</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">spf</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">policy_override_reasons</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">AggregatePolicyOverrideReason</span><span class="p">]</span></div>
+
+
+
+<div class="viewcode-block" id="AggregateRecord">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.AggregateRecord">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">AggregateRecord</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">interval_begin</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">interval_end</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">source</span><span class="p">:</span> <span class="n">IPSourceInfo</span>
+    <span class="n">count</span><span class="p">:</span> <span class="nb">int</span>
+    <span class="n">alignment</span><span class="p">:</span> <span class="n">AggregateAlignment</span>
+    <span class="n">policy_evaluated</span><span class="p">:</span> <span class="n">AggregatePolicyEvaluated</span>
+    <span class="n">disposition</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">identifiers</span><span class="p">:</span> <span class="n">AggregateIdentifiers</span>
+    <span class="n">auth_results</span><span class="p">:</span> <span class="n">AggregateAuthResults</span></div>
+
+
+
+<div class="viewcode-block" id="AggregateReport">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.AggregateReport">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">AggregateReport</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">xml_schema</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">report_metadata</span><span class="p">:</span> <span class="n">AggregateReportMetadata</span>
+    <span class="n">policy_published</span><span class="p">:</span> <span class="n">AggregatePolicyPublished</span>
+    <span class="n">records</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">AggregateRecord</span><span class="p">]</span></div>
+
+
+
+<div class="viewcode-block" id="EmailAddress">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.EmailAddress">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">EmailAddress</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">display_name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">address</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">local</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">domain</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span></div>
+
+
+
+<div class="viewcode-block" id="EmailAttachment">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.EmailAttachment">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">EmailAttachment</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">,</span> <span class="n">total</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+    <span class="n">filename</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">mail_content_type</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">sha256</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span></div>
+
+
+
+<span class="n">ParsedEmail</span> <span class="o">=</span> <span class="n">TypedDict</span><span class="p">(</span>
+    <span class="s2">&quot;ParsedEmail&quot;</span><span class="p">,</span>
+    <span class="p">{</span>
+        <span class="c1"># This is a lightly-specified version of mailsuite/mailparser JSON.</span>
+        <span class="c1"># It focuses on the fields parsedmarc uses in forensic handling.</span>
+        <span class="s2">&quot;headers&quot;</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">],</span>
+        <span class="s2">&quot;subject&quot;</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
+        <span class="s2">&quot;filename_safe_subject&quot;</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
+        <span class="s2">&quot;date&quot;</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
+        <span class="s2">&quot;from&quot;</span><span class="p">:</span> <span class="n">EmailAddress</span><span class="p">,</span>
+        <span class="s2">&quot;to&quot;</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">EmailAddress</span><span class="p">],</span>
+        <span class="s2">&quot;cc&quot;</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">EmailAddress</span><span class="p">],</span>
+        <span class="s2">&quot;bcc&quot;</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">EmailAddress</span><span class="p">],</span>
+        <span class="s2">&quot;attachments&quot;</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">EmailAttachment</span><span class="p">],</span>
+        <span class="s2">&quot;body&quot;</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
+        <span class="s2">&quot;has_defects&quot;</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span>
+        <span class="s2">&quot;defects&quot;</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span>
+        <span class="s2">&quot;defects_categories&quot;</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span>
+    <span class="p">},</span>
+    <span class="n">total</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+<span class="p">)</span>
+
+
+<div class="viewcode-block" id="ForensicReport">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.ForensicReport">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">ForensicReport</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">feedback_type</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">user_agent</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">version</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">original_envelope_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">original_mail_from</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">original_rcpt_to</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">arrival_date</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">arrival_date_utc</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">authentication_results</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">delivery_result</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">auth_failure</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">authentication_mechanisms</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">dkim_domain</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">reported_domain</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">sample_headers_only</span><span class="p">:</span> <span class="nb">bool</span>
+    <span class="n">source</span><span class="p">:</span> <span class="n">IPSourceInfo</span>
+    <span class="n">sample</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">parsed_sample</span><span class="p">:</span> <span class="n">ParsedEmail</span></div>
+
+
+
+<div class="viewcode-block" id="SMTPTLSFailureDetails">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.SMTPTLSFailureDetails">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">SMTPTLSFailureDetails</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">result_type</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">failed_session_count</span><span class="p">:</span> <span class="nb">int</span></div>
+
+
+
+<div class="viewcode-block" id="SMTPTLSFailureDetailsOptional">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.SMTPTLSFailureDetailsOptional">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">SMTPTLSFailureDetailsOptional</span><span class="p">(</span><span class="n">SMTPTLSFailureDetails</span><span class="p">,</span> <span class="n">total</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+    <span class="n">sending_mta_ip</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">receiving_ip</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">receiving_mx_hostname</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">receiving_mx_helo</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">additional_info_uri</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">failure_reason_code</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">ip_address</span><span class="p">:</span> <span class="nb">str</span></div>
+
+
+
+<div class="viewcode-block" id="SMTPTLSPolicySummary">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.SMTPTLSPolicySummary">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">SMTPTLSPolicySummary</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">policy_domain</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">policy_type</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">successful_session_count</span><span class="p">:</span> <span class="nb">int</span>
+    <span class="n">failed_session_count</span><span class="p">:</span> <span class="nb">int</span></div>
+
+
+
+<div class="viewcode-block" id="SMTPTLSPolicy">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.SMTPTLSPolicy">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">SMTPTLSPolicy</span><span class="p">(</span><span class="n">SMTPTLSPolicySummary</span><span class="p">,</span> <span class="n">total</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+    <span class="n">policy_strings</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">mx_host_patterns</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
+    <span class="n">failure_details</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">SMTPTLSFailureDetailsOptional</span><span class="p">]</span></div>
+
+
+
+<div class="viewcode-block" id="SMTPTLSReport">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.SMTPTLSReport">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">SMTPTLSReport</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">organization_name</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">begin_date</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">end_date</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">contact_info</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span>
+    <span class="n">report_id</span><span class="p">:</span> <span class="nb">str</span>
+    <span class="n">policies</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">SMTPTLSPolicy</span><span class="p">]</span></div>
+
+
+
+<div class="viewcode-block" id="AggregateParsedReport">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.AggregateParsedReport">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">AggregateParsedReport</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">report_type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;aggregate&quot;</span><span class="p">]</span>
+    <span class="n">report</span><span class="p">:</span> <span class="n">AggregateReport</span></div>
+
+
+
+<div class="viewcode-block" id="ForensicParsedReport">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.ForensicParsedReport">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">ForensicParsedReport</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">report_type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;forensic&quot;</span><span class="p">]</span>
+    <span class="n">report</span><span class="p">:</span> <span class="n">ForensicReport</span></div>
+
+
+
+<div class="viewcode-block" id="SMTPTLSParsedReport">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.SMTPTLSParsedReport">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">SMTPTLSParsedReport</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">report_type</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">&quot;smtp_tls&quot;</span><span class="p">]</span>
+    <span class="n">report</span><span class="p">:</span> <span class="n">SMTPTLSReport</span></div>
+
+
+
+<span class="n">ParsedReport</span> <span class="o">=</span> <span class="n">Union</span><span class="p">[</span><span class="n">AggregateParsedReport</span><span class="p">,</span> <span class="n">ForensicParsedReport</span><span class="p">,</span> <span class="n">SMTPTLSParsedReport</span><span class="p">]</span>
+
+
+<div class="viewcode-block" id="ParsingResults">
+<a class="viewcode-back" href="../../api.html#parsedmarc.types.ParsingResults">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">ParsingResults</span><span class="p">(</span><span class="n">TypedDict</span><span class="p">):</span>
+    <span class="n">aggregate_reports</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">AggregateReport</span><span class="p">]</span>
+    <span class="n">forensic_reports</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">ForensicReport</span><span class="p">]</span>
+    <span class="n">smtp_tls_reports</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">SMTPTLSReport</span><span class="p">]</span></div>
+
+</pre></div>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2018 - 2025, Sean Whalen and contributors.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+   
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
@@ -28,6 +28,13 @@
   :members:
 ```

+## parsedmarc.types
+
+```{eval-rst}
+.. automodule:: parsedmarc.types
+   :members:
+```
+
 ## parsedmarc.utils

 ```{eval-rst}
@@ -85,6 +85,7 @@
 | <a href="#C"><strong>C</strong></a>
 | <a href="#D"><strong>D</strong></a>
 | <a href="#E"><strong>E</strong></a>
+ | <a href="#F"><strong>F</strong></a>
 | <a href="#G"><strong>G</strong></a>
 | <a href="#H"><strong>H</strong></a>
 | <a href="#I"><strong>I</strong></a>
@@ -101,6 +102,32 @@
 <h2 id="A">A</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#parsedmarc.types.AggregateAlignment">AggregateAlignment (class in parsedmarc.types)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.AggregateAuthResultDKIM">AggregateAuthResultDKIM (class in parsedmarc.types)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.AggregateAuthResults">AggregateAuthResults (class in parsedmarc.types)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.AggregateAuthResultSPF">AggregateAuthResultSPF (class in parsedmarc.types)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.AggregateIdentifiers">AggregateIdentifiers (class in parsedmarc.types)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.AggregateParsedReport">AggregateParsedReport (class in parsedmarc.types)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#parsedmarc.types.AggregatePolicyEvaluated">AggregatePolicyEvaluated (class in parsedmarc.types)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.AggregatePolicyOverrideReason">AggregatePolicyOverrideReason (class in parsedmarc.types)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.AggregatePolicyPublished">AggregatePolicyPublished (class in parsedmarc.types)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.AggregateRecord">AggregateRecord (class in parsedmarc.types)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.AggregateReport">AggregateReport (class in parsedmarc.types)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.AggregateReportMetadata">AggregateReportMetadata (class in parsedmarc.types)</a>
+</li>
      <li><a href="api.html#parsedmarc.elastic.AlreadySaved">AlreadySaved</a>, <a href="api.html#parsedmarc.opensearch.AlreadySaved">[1]</a>
 </li>
  </ul></td>
@@ -140,9 +167,13 @@
      <li><a href="api.html#parsedmarc.elastic.ElasticsearchError">ElasticsearchError</a>
 </li>
      <li><a href="api.html#parsedmarc.email_results">email_results() (in module parsedmarc)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.EmailAddress">EmailAddress (class in parsedmarc.types)</a>
 </li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#parsedmarc.types.EmailAttachment">EmailAttachment (class in parsedmarc.types)</a>
+</li>
      <li><a href="api.html#parsedmarc.utils.EmailParserError">EmailParserError</a>
 </li>
      <li><a href="api.html#parsedmarc.extract_report">extract_report() (in module parsedmarc)</a>
@@ -152,6 +183,18 @@
  </ul></td>
 </tr></table>

+<h2 id="F">F</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#parsedmarc.types.ForensicParsedReport">ForensicParsedReport (class in parsedmarc.types)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#parsedmarc.types.ForensicReport">ForensicReport (class in parsedmarc.types)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
@@ -201,11 +244,13 @@
 </li>
      <li><a href="api.html#parsedmarc.InvalidForensicReport">InvalidForensicReport</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#parsedmarc.InvalidSMTPTLSReport">InvalidSMTPTLSReport</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#parsedmarc.utils.IPAddressInfo">IPAddressInfo (class in parsedmarc.utils)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.IPSourceInfo">IPSourceInfo (class in parsedmarc.types)</a>
 </li>
      <li><a href="api.html#parsedmarc.utils.is_mbox">is_mbox() (in module parsedmarc.utils)</a>
 </li>
@@ -234,6 +279,8 @@
        <li><a href="api.html#module-parsedmarc.opensearch">parsedmarc.opensearch</a>
 </li>
        <li><a href="api.html#module-parsedmarc.splunk">parsedmarc.splunk</a>
+</li>
+        <li><a href="api.html#module-parsedmarc.types">parsedmarc.types</a>
 </li>
        <li><a href="api.html#module-parsedmarc.utils">parsedmarc.utils</a>
 </li>
@@ -276,10 +323,12 @@
 </li>
      <li><a href="api.html#parsedmarc.parsed_smtp_tls_reports_to_csv">parsed_smtp_tls_reports_to_csv() (in module parsedmarc)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#parsedmarc.parsed_smtp_tls_reports_to_csv_rows">parsed_smtp_tls_reports_to_csv_rows() (in module parsedmarc)</a>
 </li>
+      <li><a href="api.html#parsedmarc.types.ParsedEmail">ParsedEmail (class in parsedmarc.types)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    parsedmarc

@@ -306,6 +355,13 @@

      <ul>
        <li><a href="api.html#module-parsedmarc.splunk">module</a>
+</li>
+      </ul></li>
+      <li>
+    parsedmarc.types
+
+      <ul>
+        <li><a href="api.html#module-parsedmarc.types">module</a>
 </li>
      </ul></li>
      <li>
@@ -316,6 +372,8 @@
 </li>
      </ul></li>
      <li><a href="api.html#parsedmarc.ParserError">ParserError</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.ParsingResults">ParsingResults (class in parsedmarc.types)</a>
 </li>
  </ul></td>
 </tr></table>
@@ -351,14 +409,14 @@
 </li>
      <li><a href="api.html#parsedmarc.splunk.HECClient.save_forensic_reports_to_splunk">save_forensic_reports_to_splunk() (parsedmarc.splunk.HECClient method)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#parsedmarc.save_output">save_output() (in module parsedmarc)</a>
 </li>
      <li><a href="api.html#parsedmarc.elastic.save_smtp_tls_report_to_elasticsearch">save_smtp_tls_report_to_elasticsearch() (in module parsedmarc.elastic)</a>
 </li>
      <li><a href="api.html#parsedmarc.opensearch.save_smtp_tls_report_to_opensearch">save_smtp_tls_report_to_opensearch() (in module parsedmarc.opensearch)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#parsedmarc.splunk.HECClient.save_smtp_tls_reports_to_splunk">save_smtp_tls_reports_to_splunk() (parsedmarc.splunk.HECClient method)</a>
 </li>
      <li><a href="api.html#parsedmarc.elastic.set_hosts">set_hosts() (in module parsedmarc.elastic)</a>
@@ -367,6 +425,18 @@
        <li><a href="api.html#parsedmarc.opensearch.set_hosts">(in module parsedmarc.opensearch)</a>
 </li>
      </ul></li>
+      <li><a href="api.html#parsedmarc.types.SMTPTLSFailureDetails">SMTPTLSFailureDetails (class in parsedmarc.types)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.SMTPTLSFailureDetailsOptional">SMTPTLSFailureDetailsOptional (class in parsedmarc.types)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.SMTPTLSParsedReport">SMTPTLSParsedReport (class in parsedmarc.types)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.SMTPTLSPolicy">SMTPTLSPolicy (class in parsedmarc.types)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.SMTPTLSPolicySummary">SMTPTLSPolicySummary (class in parsedmarc.types)</a>
+</li>
+      <li><a href="api.html#parsedmarc.types.SMTPTLSReport">SMTPTLSReport (class in parsedmarc.types)</a>
+</li>
      <li><a href="api.html#parsedmarc.splunk.SplunkError">SplunkError</a>
 </li>
  </ul></td>
@@ -230,6 +230,7 @@ for RHEL or Debian.</p>
 <li class="toctree-l2"><a class="reference internal" href="api.html#module-parsedmarc.elastic">parsedmarc.elastic</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api.html#module-parsedmarc.opensearch">parsedmarc.opensearch</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api.html#module-parsedmarc.splunk">parsedmarc.splunk</a></li>
+<li class="toctree-l2"><a class="reference internal" href="api.html#module-parsedmarc.types">parsedmarc.types</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api.html#module-parsedmarc.utils">parsedmarc.utils</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api.html#indices-and-tables">Indices and tables</a></li>
 </ul>
@@ -112,6 +112,11 @@
       <td>&#160;&#160;&#160;
       <a href="api.html#module-parsedmarc.splunk"><code class="xref">parsedmarc.splunk</code></a></td><td>
       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="api.html#module-parsedmarc.types"><code class="xref">parsedmarc.types</code></a></td><td>
+       <em></em></td></tr>
     <tr class="cg-1">
       <td></td>
       <td>&#160;&#160;&#160;