From 149179efe7073314e4dec10800fc08dd4f70ac04 Mon Sep 17 00:00:00 2001
From: Sean Whalen <whalenster@gmail.com>
Date: Wed, 1 Aug 2018 11:15:08 -0400
Subject: [PATCH] 3.7.1 - Add pypy documentation

---
 _modules/index.html              |  6 +--
 _modules/parsedmarc.html         |  8 ++--
 _modules/parsedmarc/elastic.html | 14 +++----
 _sources/index.rst.txt           | 63 ++++++++++++++++++++++++++++++++
 _static/documentation_options.js |  2 +-
 genindex.html                    |  6 +--
 index.html                       | 52 ++++++++++++++++++++++++--
 objects.inv                      |  2 +-
 py-modindex.html                 |  6 +--
 search.html                      |  6 +--
 searchindex.js                   |  2 +-
 11 files changed, 138 insertions(+), 29 deletions(-)

diff --git a/_modules/index.html b/_modules/index.html
index 6c689d3..3b38a22 100644
--- a/_modules/index.html
+++ b/_modules/index.html
@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Overview: module code &mdash; parsedmarc 3.7.1 documentation</title>
+  <title>Overview: module code &mdash; parsedmarc 3.7.2 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                3.7.1
+                3.7.2
               </div>
             
           
@@ -177,7 +177,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../',
-            VERSION:'3.7.1',
+            VERSION:'3.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
diff --git a/_modules/parsedmarc.html b/_modules/parsedmarc.html
index 08aba27..eadfa86 100644
--- a/_modules/parsedmarc.html
+++ b/_modules/parsedmarc.html
@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>parsedmarc &mdash; parsedmarc 3.7.1 documentation</title>
+  <title>parsedmarc &mdash; parsedmarc 3.7.2 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                3.7.1
+                3.7.2
               </div>
             
           
@@ -188,7 +188,7 @@
 <span class="kn">import</span> <span class="nn">dateparser</span>
 <span class="kn">import</span> <span class="nn">mailparser</span>
 
-<span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;3.7.1&quot;</span>
+<span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;3.7.2&quot;</span>
 
 <span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
 <span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span>
@@ -1627,7 +1627,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../',
-            VERSION:'3.7.1',
+            VERSION:'3.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
diff --git a/_modules/parsedmarc/elastic.html b/_modules/parsedmarc/elastic.html
index 3bf301e..957cf32 100644
--- a/_modules/parsedmarc/elastic.html
+++ b/_modules/parsedmarc/elastic.html
@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>parsedmarc.elastic &mdash; parsedmarc 3.7.1 documentation</title>
+  <title>parsedmarc.elastic &mdash; parsedmarc 3.7.2 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                3.7.1
+                3.7.2
               </div>
             
           
@@ -151,7 +151,7 @@
 
 <span class="kn">import</span> <span class="nn">parsedmarc</span>
 <span class="kn">from</span> <span class="nn">elasticsearch_dsl.search</span> <span class="k">import</span> <span class="n">Q</span>
-<span class="kn">from</span> <span class="nn">elasticsearch_dsl</span> <span class="k">import</span> <span class="n">connections</span><span class="p">,</span> <span class="n">Object</span><span class="p">,</span> <span class="n">DocType</span><span class="p">,</span> <span class="n">Index</span><span class="p">,</span> <span class="n">Nested</span><span class="p">,</span> \
+<span class="kn">from</span> <span class="nn">elasticsearch_dsl</span> <span class="k">import</span> <span class="n">connections</span><span class="p">,</span> <span class="n">Object</span><span class="p">,</span> <span class="n">Document</span><span class="p">,</span> <span class="n">Index</span><span class="p">,</span> <span class="n">Nested</span><span class="p">,</span> \
     <span class="n">InnerDoc</span><span class="p">,</span> <span class="n">Integer</span><span class="p">,</span> <span class="n">Text</span><span class="p">,</span> <span class="n">Boolean</span><span class="p">,</span> <span class="n">DateRange</span><span class="p">,</span> <span class="n">Ip</span><span class="p">,</span> <span class="n">Date</span>
 
 <span class="n">aggregate_index</span> <span class="o">=</span> <span class="n">Index</span><span class="p">(</span><span class="s2">&quot;dmarc_aggregate&quot;</span><span class="p">)</span>
@@ -184,7 +184,7 @@
     <span class="n">results</span> <span class="o">=</span> <span class="n">Text</span><span class="p">()</span>
 
 
-<span class="k">class</span> <span class="nc">_AggregateReportDoc</span><span class="p">(</span><span class="n">DocType</span><span class="p">):</span>
+<span class="k">class</span> <span class="nc">_AggregateReportDoc</span><span class="p">(</span><span class="n">Document</span><span class="p">):</span>
     <span class="k">class</span> <span class="nc">Index</span><span class="p">:</span>
         <span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;dmarc_aggregate&quot;</span>
 
@@ -239,7 +239,7 @@
     <span class="n">address</span> <span class="o">=</span> <span class="n">Text</span><span class="p">()</span>
 
 
-<span class="k">class</span> <span class="nc">_EmailAttachmentDoc</span><span class="p">(</span><span class="n">DocType</span><span class="p">):</span>
+<span class="k">class</span> <span class="nc">_EmailAttachmentDoc</span><span class="p">(</span><span class="n">Document</span><span class="p">):</span>
     <span class="n">filename</span> <span class="o">=</span> <span class="n">Text</span><span class="p">()</span>
     <span class="n">content_type</span> <span class="o">=</span> <span class="n">Text</span><span class="p">()</span>
 
@@ -280,7 +280,7 @@
                                 <span class="n">content_type</span><span class="o">=</span><span class="n">content_type</span><span class="p">)</span>
 
 
-<span class="k">class</span> <span class="nc">_ForensicReportDoc</span><span class="p">(</span><span class="n">DocType</span><span class="p">):</span>
+<span class="k">class</span> <span class="nc">_ForensicReportDoc</span><span class="p">(</span><span class="n">Document</span><span class="p">):</span>
     <span class="k">class</span> <span class="nc">Index</span><span class="p">:</span>
         <span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;dmarc_forensic&quot;</span>
 
@@ -545,7 +545,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../',
-            VERSION:'3.7.1',
+            VERSION:'3.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
index 1cc2a9e..21cc9fb 100644
--- a/_sources/index.rst.txt
+++ b/_sources/index.rst.txt
@@ -249,6 +249,57 @@ Or, install the latest development release directly from GitHub:
     substitute ``pip`` as an administrator in place of ``sudo pip3``, in the
     above commands.
 
+
+Installation using pypy3
+------------------------
+
+For the best possible processing speed, consider using `parsedmarc` inside a ``pypy3``
+virtualenv. First, `download the latest version of pypy3`_. Extract it to
+``/opt/pypy3`` (``sudo mkdir /opt`` if ``/opt`` does not exist), then create a
+symlink:
+
+.. code-block:: bash
+
+    $ sudo ln -s /opt/pypy3/bin/pypy3 /usr/local/bin/pypy3
+
+Install ``virtualenv`` on your system:
+
+.. code-block:: bash
+
+    $ sudo apt-get install python3-pip
+    $ sudo -H pip3 install -U virtualenv
+
+Uninstall any instance of ``parsedmarc`` that you may have installed globally
+
+.. code-block:: bash
+
+    $ sudo -H pip3 uninstall -y parsedmarc
+
+Next, create a ``pypy3`` virtualenv for parsedmarc
+
+
+.. code-block:: bash
+
+    $ sudo mkdir /opt/venvs
+    $ cd /opt/venvs
+    $ sudo -H pip3 install -U virtualenv
+    $ sudo virtualenv --download -p /usr/local/bin/pypy3 parsedmarc
+    $ sudo -H /opt/venvs/parsedmarc/bin/pip3 install -U parsedmarc
+    $ sudo ln -s /opt/venvs/parsedmarc/bin/parsedmarc /usr/local/bin/parsedmarc
+
+To upgrade ``parsedmarc`` inside the virtualenv, run:
+
+
+.. code-block:: bash
+
+    $ sudo -H /opt/venvs/parsedmarc/bin/pip3 install -U parsedmarc
+
+Or, install the latest development release directly from GitHub:
+
+.. code-block:: bash
+
+    $ sudo -H /opt/venvs/parsedmarc/bin/pip3 install -U git+https://github.com/domainaware/parsedmarc.git
+
 Optional dependencies
 ---------------------
 
@@ -549,6 +600,16 @@ Use this command to check the status of the service:
 
     sudo service parsedmarc status
 
+.. warning::
+
+    Always restart the service every time you upgrade to a new version of
+    ``parsedmarc``:
+
+   .. code-block:: bash
+
+       sudo service parsedmarc restart
+
+
 Using the Kibana dashboards
 ===========================
 
@@ -720,6 +781,8 @@ Indices and tables
 
 .. _Demystifying DMARC: https://seanthegeek.net/459/demystifying-dmarc/
 
+.. _download the latest version of pypy3: https://pypy.org/download.html#default-with-a-jit-compiler
+
 .. _X-Pack: https://www.elastic.co/products/x-pack
 
 .. _kibana_saved_objects.json: https://raw.githubusercontent.com/domainaware/parsedmarc/master/kibana/kibana_saved_objects.json
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
index 328b41a..66e242a 100644
--- a/_static/documentation_options.js
+++ b/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '3.7.1',
+    VERSION: '3.7.2',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',
diff --git a/genindex.html b/genindex.html
index 3f78bd4..d3700c9 100644
--- a/genindex.html
+++ b/genindex.html
@@ -9,7 +9,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Index &mdash; parsedmarc 3.7.1 documentation</title>
+  <title>Index &mdash; parsedmarc 3.7.2 documentation</title>
   
 
   
@@ -57,7 +57,7 @@
             
             
               <div class="version">
-                3.7.1
+                3.7.2
               </div>
             
           
@@ -310,7 +310,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'3.7.1',
+            VERSION:'3.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
diff --git a/index.html b/index.html
index 8fd2afe..fd4b258 100644
--- a/index.html
+++ b/index.html
@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Welcome to parsedmarc’s documentation! &mdash; parsedmarc 3.7.1 documentation</title>
+  <title>Welcome to parsedmarc’s documentation! &mdash; parsedmarc 3.7.2 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                3.7.1
+                3.7.2
               </div>
             
           
@@ -95,6 +95,7 @@
 <li><a class="reference internal" href="#sample-forensic-report-output">Sample forensic report output</a></li>
 <li><a class="reference internal" href="#bug-reports">Bug reports</a></li>
 <li><a class="reference internal" href="#installation">Installation</a><ul>
+<li><a class="reference internal" href="#installation-using-pypy3">Installation using pypy3</a></li>
 <li><a class="reference internal" href="#optional-dependencies">Optional dependencies</a></li>
 <li><a class="reference internal" href="#elasticsearch-and-kibana">Elasticsearch and Kibana</a></li>
 <li><a class="reference internal" href="#running-parsedmarc-as-a-systemd-service">Running parsedmarc as a systemd service</a></li>
@@ -395,6 +396,42 @@ macOS or Linux, run</p>
 substitute <code class="docutils literal notranslate"><span class="pre">pip</span></code> as an administrator in place of <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">pip3</span></code>, in the
 above commands.</p>
 </div>
+<div class="section" id="installation-using-pypy3">
+<h3>Installation using pypy3<a class="headerlink" href="#installation-using-pypy3" title="Permalink to this headline">¶</a></h3>
+<p>For the best possible processing speed, consider using <cite>parsedmarc</cite> inside a <code class="docutils literal notranslate"><span class="pre">pypy3</span></code>
+virtualenv. First, <a class="reference external" href="https://pypy.org/download.html#default-with-a-jit-compiler">download the latest version of pypy3</a>. Extract it to
+<code class="docutils literal notranslate"><span class="pre">/opt/pypy3</span></code> (<code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">mkdir</span> <span class="pre">/opt</span></code> if <code class="docutils literal notranslate"><span class="pre">/opt</span></code> does not exist), then create a
+symlink:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo ln -s /opt/pypy3/bin/pypy3 /usr/local/bin/pypy3
+</pre></div>
+</div>
+<p>Install <code class="docutils literal notranslate"><span class="pre">virtualenv</span></code> on your system:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo apt-get install python3-pip
+$ sudo -H pip3 install -U virtualenv
+</pre></div>
+</div>
+<p>Uninstall any instance of <code class="docutils literal notranslate"><span class="pre">parsedmarc</span></code> that you may have installed globally</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo -H pip3 uninstall -y parsedmarc
+</pre></div>
+</div>
+<p>Next, create a <code class="docutils literal notranslate"><span class="pre">pypy3</span></code> virtualenv for parsedmarc</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo mkdir /opt/venvs
+$ <span class="nb">cd</span> /opt/venvs
+$ sudo -H pip3 install -U virtualenv
+$ sudo virtualenv --download -p /usr/local/bin/pypy3 parsedmarc
+$ sudo -H /opt/venvs/parsedmarc/bin/pip3 install -U parsedmarc
+$ sudo ln -s /opt/venvs/parsedmarc/bin/parsedmarc /usr/local/bin/parsedmarc
+</pre></div>
+</div>
+<p>To upgrade <code class="docutils literal notranslate"><span class="pre">parsedmarc</span></code> inside the virtualenv, run:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo -H /opt/venvs/parsedmarc/bin/pip3 install -U parsedmarc
+</pre></div>
+</div>
+<p>Or, install the latest development release directly from GitHub:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo -H /opt/venvs/parsedmarc/bin/pip3 install -U git+https://github.com/domainaware/parsedmarc.git
+</pre></div>
+</div>
+</div>
 <div class="section" id="optional-dependencies">
 <h3>Optional dependencies<a class="headerlink" href="#optional-dependencies" title="Permalink to this headline">¶</a></h3>
 <p>If you would like to be able to parse emails saved from Microsoft Outlook
@@ -610,6 +647,15 @@ sudo service parsedmarc restart
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo service parsedmarc status
 </pre></div>
 </div>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<blockquote>
+<div>Always restart the service every time you upgrade to a new version of
+<code class="docutils literal notranslate"><span class="pre">parsedmarc</span></code>:</div></blockquote>
+<div class="last highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo service parsedmarc restart
+</pre></div>
+</div>
+</div>
 </div>
 </div>
 <div class="section" id="using-the-kibana-dashboards">
@@ -1244,7 +1290,7 @@ to a callback function</p>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'3.7.1',
+            VERSION:'3.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
diff --git a/objects.inv b/objects.inv
index ce5f8d8..415c9c6 100644
--- a/objects.inv
+++ b/objects.inv
@@ -1,5 +1,5 @@
 # Sphinx inventory version 2
 # Project: parsedmarc
-# Version: 3.7.1
+# Version: 3.7.2
 # The remainder of this file is compressed using zlib.
 xڭ�KN�0��=�lS�mw��HU���r�ibɎ-{RRV\��q�$����;k��x�e΃��qb�smD���Yh�ju�Dz�M�x�(��s�EZ����<G�SR�e�d+��a2_䫻�G������xt�������be�(h�+L��l"9��vB��65������h��L��A�!���l������V�cB��I��F�P-:Ƒ�Z�f�p��4T����1m��ЬWiGcU�YMQj�ȴ��a�10ڣ;�܄�T�Hicoq�9������ehz��G�>���]��Y��6ݯg�����0�՘]-��"ģ�+�
E�9D;Y���(�Gщ�7a7ѐ�%>��=	�FC�,������tv�>�~E���������z���d%L>
%;��
\ No newline at end of file
diff --git a/py-modindex.html b/py-modindex.html
index 993434a..15c826f 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Python Module Index &mdash; parsedmarc 3.7.1 documentation</title>
+  <title>Python Module Index &mdash; parsedmarc 3.7.2 documentation</title>
   
 
   
@@ -59,7 +59,7 @@
             
             
               <div class="version">
-                3.7.1
+                3.7.2
               </div>
             
           
@@ -200,7 +200,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'3.7.1',
+            VERSION:'3.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
diff --git a/search.html b/search.html
index 8b0e260..fed1374 100644
--- a/search.html
+++ b/search.html
@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Search &mdash; parsedmarc 3.7.1 documentation</title>
+  <title>Search &mdash; parsedmarc 3.7.2 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                3.7.1
+                3.7.2
               </div>
             
           
@@ -188,7 +188,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'3.7.1',
+            VERSION:'3.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
diff --git a/searchindex.js b/searchindex.js
index 140f5e9..8794a39 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["index"],envversion:53,filenames:["index.rst"],objects:{"":{parsedmarc:[0,0,0,"-"]},"parsedmarc.elastic":{AlreadySaved:[0,1,1,""],create_indexes:[0,2,1,""],save_aggregate_report_to_elasticsearch:[0,2,1,""],save_forensic_report_to_elasticsearch:[0,2,1,""],set_hosts:[0,2,1,""]},parsedmarc:{IMAPError:[0,1,1,""],InvalidAggregateReport:[0,1,1,""],InvalidDMARCReport:[0,1,1,""],InvalidForensicReport:[0,1,1,""],ParserError:[0,1,1,""],SMTPError:[0,1,1,""],elastic:[0,0,0,"-"],email_results:[0,2,1,""],extract_xml:[0,2,1,""],get_dmarc_reports_from_inbox:[0,2,1,""],get_report_zip:[0,2,1,""],human_timestamp_to_datetime:[0,2,1,""],parse_aggregate_report_file:[0,2,1,""],parse_aggregate_report_xml:[0,2,1,""],parse_forensic_report:[0,2,1,""],parse_report_email:[0,2,1,""],parse_report_file:[0,2,1,""],parsed_aggregate_reports_to_csv:[0,2,1,""],parsed_forensic_reports_to_csv:[0,2,1,""],save_output:[0,2,1,""],watch_inbox:[0,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","exception","Python exception"],"2":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:exception","2":"py:function"},terms:{"50m":0,"break":0,"byte":0,"case":0,"default":0,"float":0,"function":0,"import":0,"int":0,"long":0,"new":0,"null":0,"public":0,"return":0,"switch":0,"true":0,"while":0,DNS:0,For:0,OLE:0,That:0,The:0,Then:0,These:0,Use:0,With:0,_input:0,abl:0,about:0,abov:0,access:0,account:0,acm:0,across:0,actual:0,add:0,add_head:0,address:0,addresse:0,adkim:0,administr:0,adsl:0,aes256:0,after:0,against:0,agari:0,age:0,aggregate_report:0,all:0,alreadysav:0,also:0,alter:0,altern:0,alwai:0,ani:0,answer:0,apache2:0,appear:0,appendix:0,apt:0,archiv:0,archive_fold:0,argument:0,arriv:0,arrival_d:0,artifact:0,ask:0,aspf:0,attach:0,attachment_filenam:0,auth_bas:0,auth_basic_user_fil:0,auth_result:0,authent:0,avail:0,avoid:0,b2c:0,base:0,base_domain:0,basic:0,becaus:0,been:0,begin_d:0,bellsouth:0,below:0,best:0,between:0,bin:0,bodi:0,bool:0,brand:0,busi:0,call:0,callback:0,can:0,caus:0,center:0,cert:0,certif:0,chac:0,chacha20:0,chang:0,chart:0,check:0,checkdmarc:0,chines:0,chmod:0,chown:0,click:0,cloudflar:0,collect:0,com:0,come:0,command:0,commerci:0,common:0,compress:0,configur:0,connect:0,consid:0,consist:0,consolid:0,consum:0,contact:0,contain:0,content:0,context:0,control:0,convert:0,copi:0,correctli:0,could:0,count:0,countri:0,creat:0,create_index:0,crt:0,csr:0,custom:0,daemon:0,dai:0,daili:0,data:0,date_rang:0,datetim:0,deb:0,debian:0,debug:0,delet:0,demystifi:0,descript:0,detail:0,develop:0,dhparam:0,differ:0,directli:0,directori:0,disabl:0,displai:0,disposit:0,dkim_align:0,dkim_domain:0,dkim_result:0,dkim_selector:0,dkm:0,dmarc_aggreg:0,dmarc_forens:0,dmarcian:0,dns_timeout:0,doe:0,domain:0,domainawar:0,don:0,down:0,download:0,draft:0,earlier:0,ecdh:0,ecdsa:0,echo:0,edit:0,elasticsearch_host:0,els:0,email:0,email_result:0,enabl:0,encount:0,end:0,end_dat:0,ensur:0,entir:0,envelop:0,envelope_from:0,envelope_to:0,error:0,especi:0,etc:0,even:0,exampl:0,exampleus:0,except:0,execstart:0,exist:0,exit:0,extract:0,extract_xml:0,fail:0,failur:0,fals:0,feedback:0,feedback_report:0,fetch:0,few:0,field:0,file:0,file_path:0,filenam:0,fill:0,filter:0,financ:0,find:0,first:0,flag:0,flat:0,folder:0,foobar:0,forensic_report:0,format:0,forward:0,found:0,fqdn:0,frame:0,friendli:0,from:0,full:0,further:0,gcm:0,gener:0,get:0,get_dmarc_reports_from_inbox:0,get_report_zip:0,git:0,github:0,give:0,given:0,glass:0,gmail:0,googl:0,gpg:0,graph:0,group:0,gzip:0,handl:0,has:0,have:0,header:0,header_from:0,healthcar:0,here:0,high:0,highli:0,host:0,hostnam:0,hover:0,htpasswd:0,http2:0,http:0,httpasswd:0,human:0,human_timestamp:0,human_timestamp_to_datetim:0,icon:0,identifi:0,idl:0,imap:0,imaperror:0,inbox:0,includ:0,includesubdomain:0,incom:0,index:0,industri:0,inform:0,input:0,input_:0,instanc:0,instead:0,invalid:0,invalidaggregatereport:0,invaliddmarcreport:0,invalidforensicreport:0,ip_address:0,issu:0,its:0,jre:0,just:0,kei:0,keyout:0,kibana_saved_object:0,kind:0,know:0,known:0,later:0,latest:0,leak:0,least:0,leav:0,left:0,legitim:0,level:0,libemail:0,like:0,line:0,link:0,linux:0,list:0,listen:0,local:0,localhost:0,locat:0,log:0,login:0,look:0,lot:0,maco:0,magnifi:0,mai:0,mail:0,mail_from:0,mail_to:0,mailbox:0,main:0,malici:0,manag:0,market:0,match:0,max:0,mechan:0,mention:0,menu:0,messag:0,mfrom:0,microsoft:0,might:0,mkdir:0,modul:0,more:0,most:0,mous:0,move:0,msg:0,msgconvert:0,multi:0,must:0,name:0,nameserv:0,nano:0,need:0,net:0,newkei:0,newli:0,next:0,nginx:0,node:0,none:0,norepli:0,normal:0,nosniff:0,notabl:0,now:0,number:0,object:0,observ:0,occur:0,off:0,office365:0,often:0,old:0,older:0,onc:0,ondmarc:0,one:0,onli:0,open:0,openjdk:0,openssl:0,ordereddict:0,org:0,org_email:0,org_extra_contact_info:0,org_nam:0,organ:0,origin:0,other:0,our:0,out:0,outdat:0,outgo:0,outgoing_attach:0,outgoing_from:0,outgoing_host:0,outgoing_messag:0,outgoing_password:0,outgoing_subject:0,outgoing_to:0,outgoing_us:0,outlook:0,output_directori:0,over:0,overrid:0,overwrit:0,own:0,pack:0,packag:0,page:0,paramet:0,parent:0,pars:0,parse_aggregate_report_fil:0,parse_aggregate_report_xml:0,parse_forensic_report:0,parse_report_email:0,parse_report_fil:0,parsed_aggregate_reports_to_csv:0,parsed_forensic_reports_to_csv:0,parser:0,parsererror:0,part:0,particular:0,particularli:0,pass:0,passag:0,password:0,patch:0,path:0,pattern:0,pct:0,pem:0,percentag:0,perl:0,permiss:0,pie:0,pip3:0,pip:0,place:0,plain:0,pleas:0,plu:0,polici:0,policy_evalu:0,policy_override_com:0,policy_override_reason:0,policy_publish:0,poly1305:0,port:0,posit:0,possibl:0,preload:0,premad:0,previous:0,print:0,privaci:0,process:0,produc:0,program:0,project:0,prompt:0,provid:0,proxi:0,proxy_add_x_forwarded_for:0,proxy_pass:0,proxy_set_head:0,publicli:0,publish:0,python3:0,python:0,queri:0,rais:0,readabl:0,real:0,realli:0,reason:0,receiv:0,recipi:0,recogn:0,regardless:0,regul:0,regulatori:0,relai:0,relat:0,releas:0,reli:0,reload:0,remain:0,remote_addr:0,remov:0,report_id:0,report_metadata:0,report_typ:0,reports_fold:0,req:0,request:0,request_uri:0,requir:0,resolv:0,respons:0,restart:0,restartsec:0,restor:0,result:0,revers:0,reverse_dn:0,review:0,rfc:0,right:0,root:0,rsa:0,rua:0,ruf:0,rule:0,same:0,sameorigin:0,sample_headers_onli:0,save:0,save_aggregate_report_to_elasticsearch:0,save_forensic_report_to_elasticsearch:0,save_output:0,schema:0,scope:0,search:0,second:0,secur:0,see:0,segment:0,select:0,selector:0,self:0,send:0,sensit:0,sent:0,separ:0,server:0,server_nam:[],session:0,set:0,set_host:0,sha384:0,share:0,should:0,show:0,shown:0,shv:0,side:0,sign:0,signatur:0,silent:0,similar:0,simpl:0,simpli:0,singl:0,sister:0,site:0,smtp:0,smtperror:0,some:0,someon:0,sometim:0,sort:0,sourc:0,source_base_domain:0,source_countri:0,source_ip_address:0,source_reverse_dn:0,specif:0,specifi:0,spf_align:0,spf_domain:0,spf_result:0,spf_scope:0,spoof:0,ssl:0,ssl_certif:0,ssl_certificate_kei:0,ssl_cipher:0,ssl_context:0,ssl_dhparam:0,ssl_prefer_server_ciph:0,ssl_protocol:0,ssl_session_cach:0,ssl_session_ticket:0,ssl_session_timeout:0,stabl:0,standard:0,start:0,starttl:0,statu:0,still:0,store:0,str:0,strict:0,string:0,structur:0,subdomain:0,subject:0,subsidiari:0,substitut:0,sudo:0,suggest:0,suit:0,suppli:0,system:0,systemctl:0,tab:0,target:0,tee:0,tell:0,temporari:0,test:0,text:0,thei:0,theirs:0,them:0,thi:0,three:0,through:0,time:0,timeout:0,timestamp:0,tld:0,tlsv1:0,top:0,tracker:0,transpar:0,transport:0,trust:0,type:0,ubuntu:0,uncom:0,under:0,underneath:0,understand:0,unit:0,updat:0,upgrad:0,upper:0,url:0,usag:0,use:0,use_ssl:0,used:0,useful:0,user:0,usernam:0,using:0,usr:0,util:0,valu:0,vendor:0,veri:0,version:0,view:0,visit:0,visual:0,volum:0,vulner:0,wai:0,wait:0,want:0,wantedbi:0,watch:0,watch_inbox:0,watcher:0,web:0,webmail:0,were:0,wget:0,when:0,whenev:0,where:0,wherea:0,which:0,who:0,why:0,wide:0,wiki:0,window:0,without:0,work:0,worst:0,would:0,write:0,www:0,x509:0,xml:0,xml_schema:0,yahoo:0,yet:0,you:0,your:0,yyyi:0,zip:0},titles:["Welcome to parsedmarc\u2019s documentation!"],titleterms:{Using:0,aggreg:0,align:0,api:0,bug:0,cli:0,csv:0,dashboard:0,depend:0,dkim:0,dmarc:0,document:0,elast:0,elasticsearch:0,featur:0,forens:0,guid:0,help:0,indic:0,instal:0,json:0,kibana:0,option:0,output:0,parsedmarc:0,record:0,report:0,resourc:0,run:0,sampl:0,sender:0,servic:0,spf:0,summari:0,support:0,systemd:0,tabl:0,valid:0,welcom:0,what:0,won:0}})
\ No newline at end of file
+Search.setIndex({docnames:["index"],envversion:53,filenames:["index.rst"],objects:{"":{parsedmarc:[0,0,0,"-"]},"parsedmarc.elastic":{AlreadySaved:[0,1,1,""],create_indexes:[0,2,1,""],save_aggregate_report_to_elasticsearch:[0,2,1,""],save_forensic_report_to_elasticsearch:[0,2,1,""],set_hosts:[0,2,1,""]},parsedmarc:{IMAPError:[0,1,1,""],InvalidAggregateReport:[0,1,1,""],InvalidDMARCReport:[0,1,1,""],InvalidForensicReport:[0,1,1,""],ParserError:[0,1,1,""],SMTPError:[0,1,1,""],elastic:[0,0,0,"-"],email_results:[0,2,1,""],extract_xml:[0,2,1,""],get_dmarc_reports_from_inbox:[0,2,1,""],get_report_zip:[0,2,1,""],human_timestamp_to_datetime:[0,2,1,""],parse_aggregate_report_file:[0,2,1,""],parse_aggregate_report_xml:[0,2,1,""],parse_forensic_report:[0,2,1,""],parse_report_email:[0,2,1,""],parse_report_file:[0,2,1,""],parsed_aggregate_reports_to_csv:[0,2,1,""],parsed_forensic_reports_to_csv:[0,2,1,""],save_output:[0,2,1,""],watch_inbox:[0,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","exception","Python exception"],"2":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:exception","2":"py:function"},terms:{"50m":0,"break":0,"byte":0,"case":0,"default":0,"float":0,"function":0,"import":0,"int":0,"long":0,"new":0,"null":0,"public":0,"return":0,"switch":0,"true":0,"while":0,DNS:0,For:0,OLE:0,That:0,The:0,Then:0,These:0,Use:0,With:0,_input:0,abl:0,about:0,abov:0,access:0,account:0,acm:0,across:0,actual:0,add:0,add_head:0,address:0,addresse:0,adkim:0,administr:0,adsl:0,aes256:0,after:0,against:0,agari:0,age:0,aggregate_report:0,all:0,alreadysav:0,also:0,alter:0,altern:0,alwai:0,ani:0,answer:0,apache2:0,appear:0,appendix:0,apt:0,archiv:0,archive_fold:0,argument:0,arriv:0,arrival_d:0,artifact:0,ask:0,aspf:0,attach:0,attachment_filenam:0,auth_bas:0,auth_basic_user_fil:0,auth_result:0,authent:0,avail:0,avoid:0,b2c:0,base:0,base_domain:0,basic:0,becaus:0,been:0,begin_d:0,bellsouth:0,below:0,best:0,between:0,bin:0,bodi:0,bool:0,brand:0,busi:0,call:0,callback:0,can:0,caus:0,center:0,cert:0,certif:0,chac:0,chacha20:0,chang:0,chart:0,check:0,checkdmarc:0,chines:0,chmod:0,chown:0,click:0,cloudflar:0,collect:0,com:0,come:0,command:0,commerci:0,common:0,compress:0,configur:0,connect:0,consid:0,consist:0,consolid:0,consum:0,contact:0,contain:0,content:0,context:0,control:0,convert:0,copi:0,correctli:0,could:0,count:0,countri:0,creat:0,create_index:0,crt:0,csr:0,custom:0,daemon:0,dai:0,daili:0,data:0,date_rang:0,datetim:0,deb:0,debian:0,debug:0,delet:0,demystifi:0,descript:0,detail:0,develop:0,dhparam:0,differ:0,directli:0,directori:0,disabl:0,displai:0,disposit:0,dkim_align:0,dkim_domain:0,dkim_result:0,dkim_selector:0,dkm:0,dmarc_aggreg:0,dmarc_forens:0,dmarcian:0,dns_timeout:0,doe:0,domain:0,domainawar:0,don:0,down:0,download:0,draft:0,earlier:0,ecdh:0,ecdsa:0,echo:0,edit:0,elasticsearch_host:0,els:0,email:0,email_result:0,enabl:0,encount:0,end:0,end_dat:0,ensur:0,entir:0,envelop:0,envelope_from:0,envelope_to:0,error:0,especi:0,etc:0,even:0,everi:0,exampl:0,exampleus:0,except:0,execstart:0,exist:0,exit:0,extract:0,extract_xml:0,fail:0,failur:0,fals:0,feedback:0,feedback_report:0,fetch:0,few:0,field:0,file:0,file_path:0,filenam:0,fill:0,filter:0,financ:0,find:0,first:0,flag:0,flat:0,folder:0,foobar:0,forensic_report:0,format:0,forward:0,found:0,fqdn:0,frame:0,friendli:0,from:0,full:0,further:0,gcm:0,gener:0,get:0,get_dmarc_reports_from_inbox:0,get_report_zip:0,git:0,github:0,give:0,given:0,glass:0,global:0,gmail:0,googl:0,gpg:0,graph:0,group:0,gzip:0,handl:0,has:0,have:0,header:0,header_from:0,healthcar:0,here:0,high:0,highli:0,host:0,hostnam:0,hover:0,htpasswd:0,http2:0,http:0,httpasswd:0,human:0,human_timestamp:0,human_timestamp_to_datetim:0,icon:0,identifi:0,idl:0,imap:0,imaperror:0,inbox:0,includ:0,includesubdomain:0,incom:0,index:0,industri:0,inform:0,input:0,input_:0,insid:0,instanc:0,instead:0,invalid:0,invalidaggregatereport:0,invaliddmarcreport:0,invalidforensicreport:0,ip_address:0,issu:0,its:0,jre:0,just:0,kei:0,keyout:0,kibana_saved_object:0,kind:0,know:0,known:0,later:0,latest:0,leak:0,least:0,leav:0,left:0,legitim:0,level:0,libemail:0,like:0,line:0,link:0,linux:0,list:0,listen:0,local:0,localhost:0,locat:0,log:0,login:0,look:0,lot:0,maco:0,magnifi:0,mai:0,mail:0,mail_from:0,mail_to:0,mailbox:0,main:0,malici:0,manag:0,market:0,match:0,max:0,mechan:0,mention:0,menu:0,messag:0,mfrom:0,microsoft:0,might:0,mkdir:0,modul:0,more:0,most:0,mous:0,move:0,msg:0,msgconvert:0,multi:0,must:0,name:0,nameserv:0,nano:0,need:0,net:0,newkei:0,newli:0,next:0,nginx:0,node:0,none:0,norepli:0,normal:0,nosniff:0,notabl:0,now:0,number:0,object:0,observ:0,occur:0,off:0,office365:0,often:0,old:0,older:0,onc:0,ondmarc:0,one:0,onli:0,open:0,openjdk:0,openssl:0,opt:0,ordereddict:0,org:0,org_email:0,org_extra_contact_info:0,org_nam:0,organ:0,origin:0,other:0,our:0,out:0,outdat:0,outgo:0,outgoing_attach:0,outgoing_from:0,outgoing_host:0,outgoing_messag:0,outgoing_password:0,outgoing_subject:0,outgoing_to:0,outgoing_us:0,outlook:0,output_directori:0,over:0,overrid:0,overwrit:0,own:0,pack:0,packag:0,page:0,paramet:0,parent:0,pars:0,parse_aggregate_report_fil:0,parse_aggregate_report_xml:0,parse_forensic_report:0,parse_report_email:0,parse_report_fil:0,parsed_aggregate_reports_to_csv:0,parsed_forensic_reports_to_csv:0,parser:0,parsererror:0,part:0,particular:0,particularli:0,pass:0,passag:0,password:0,patch:0,path:0,pattern:0,pct:0,pem:0,percentag:0,perl:0,permiss:0,pie:0,pip3:0,pip:0,place:0,plain:0,pleas:0,plu:0,polici:0,policy_evalu:0,policy_override_com:0,policy_override_reason:0,policy_publish:0,poly1305:0,port:0,posit:0,possibl:0,preload:0,premad:0,previous:0,print:0,privaci:0,process:0,produc:0,program:0,project:0,prompt:0,provid:0,proxi:0,proxy_add_x_forwarded_for:0,proxy_pass:0,proxy_set_head:0,publicli:0,publish:0,python3:0,python:0,queri:0,rais:0,readabl:0,real:0,realli:0,reason:0,receiv:0,recipi:0,recogn:0,regardless:0,regul:0,regulatori:0,relai:0,relat:0,releas:0,reli:0,reload:0,remain:0,remote_addr:0,remov:0,report_id:0,report_metadata:0,report_typ:0,reports_fold:0,req:0,request:0,request_uri:0,requir:0,resolv:0,respons:0,restart:0,restartsec:0,restor:0,result:0,revers:0,reverse_dn:0,review:0,rfc:0,right:0,root:0,rsa:0,rua:0,ruf:0,rule:0,same:0,sameorigin:0,sample_headers_onli:0,save:0,save_aggregate_report_to_elasticsearch:0,save_forensic_report_to_elasticsearch:0,save_output:0,schema:0,scope:0,search:0,second:0,secur:0,see:0,segment:0,select:0,selector:0,self:0,send:0,sensit:0,sent:0,separ:0,server:0,server_nam:[],session:0,set:0,set_host:0,sha384:0,share:0,should:0,show:0,shown:0,shv:0,side:0,sign:0,signatur:0,silent:0,similar:0,simpl:0,simpli:0,singl:0,sister:0,site:0,smtp:0,smtperror:0,some:0,someon:0,sometim:0,sort:0,sourc:0,source_base_domain:0,source_countri:0,source_ip_address:0,source_reverse_dn:0,specif:0,specifi:0,speed:0,spf_align:0,spf_domain:0,spf_result:0,spf_scope:0,spoof:0,ssl:0,ssl_certif:0,ssl_certificate_kei:0,ssl_cipher:0,ssl_context:0,ssl_dhparam:0,ssl_prefer_server_ciph:0,ssl_protocol:0,ssl_session_cach:0,ssl_session_ticket:0,ssl_session_timeout:0,stabl:0,standard:0,start:0,starttl:0,statu:0,still:0,store:0,str:0,strict:0,string:0,structur:0,subdomain:0,subject:0,subsidiari:0,substitut:0,sudo:0,suggest:0,suit:0,suppli:0,symlink:0,system:0,systemctl:0,tab:0,target:0,tee:0,tell:0,temporari:0,test:0,text:0,thei:0,theirs:0,them:0,thi:0,three:0,through:0,time:0,timeout:0,timestamp:0,tld:0,tlsv1:0,top:0,tracker:0,transpar:0,transport:0,trust:0,type:0,ubuntu:0,uncom:0,under:0,underneath:0,understand:0,uninstal:0,unit:0,updat:0,upgrad:0,upper:0,url:0,usag:0,use:0,use_ssl:0,used:0,useful:0,user:0,usernam:0,using:[],usr:0,util:0,valu:0,vendor:0,venv:0,veri:0,version:0,view:0,virtualenv:0,visit:0,visual:0,volum:0,vulner:0,wai:0,wait:0,want:0,wantedbi:0,watch:0,watch_inbox:0,watcher:0,web:0,webmail:0,were:0,wget:0,when:0,whenev:0,where:0,wherea:0,which:0,who:0,why:0,wide:0,wiki:0,window:0,without:0,work:0,worst:0,would:0,write:0,www:0,x509:0,xml:0,xml_schema:0,yahoo:0,yet:0,you:0,your:0,yyyi:0,zip:0},titles:["Welcome to parsedmarc\u2019s documentation!"],titleterms:{Using:0,aggreg:0,align:0,api:0,bug:0,cli:0,csv:0,dashboard:0,depend:0,dkim:0,dmarc:0,document:0,elast:0,elasticsearch:0,featur:0,forens:0,guid:0,help:0,indic:0,instal:0,json:0,kibana:0,option:0,output:0,parsedmarc:0,pypy3:0,record:0,report:0,resourc:0,run:0,sampl:0,sender:0,servic:0,spf:0,summari:0,support:0,systemd:0,tabl:0,using:0,valid:0,welcom:0,what:0,won:0}})
\ No newline at end of file