8.0.3

2026-05-21 11:25:23 +00:00 · 2022-05-02 16:36:59 -04:00
parent eab6b78c64
commit 7d4b5890d2
10 changed files with 74 additions and 48 deletions
@@ -3,7 +3,7 @@
 <head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; parsedmarc 8.0.2 documentation</title>
+  <title>Overview: module code &mdash; parsedmarc 8.0.3 documentation</title>
      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <!--[if lt IE 9]>
@@ -27,7 +27,7 @@
            <a href="../index.html" class="icon icon-home"> parsedmarc
          </a>
              <div class="version">
-                8.0.2
+                8.0.3
              </div>
 <div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -3,7 +3,7 @@
 <head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>parsedmarc &mdash; parsedmarc 8.0.2 documentation</title>
+  <title>parsedmarc &mdash; parsedmarc 8.0.3 documentation</title>
      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <!--[if lt IE 9]>
@@ -27,7 +27,7 @@
            <a href="../index.html" class="icon icon-home"> parsedmarc
          </a>
              <div class="version">
-                8.0.2
+                8.0.3
              </div>
 <div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -100,7 +100,7 @@
 <span class="kn">from</span> <span class="nn">parsedmarc.utils</span> <span class="kn">import</span> <span class="n">parse_email</span>
 <span class="kn">from</span> <span class="nn">parsedmarc.utils</span> <span class="kn">import</span> <span class="n">timestamp_to_human</span><span class="p">,</span> <span class="n">human_timestamp_to_datetime</span>

-<span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;8.0.2&quot;</span>
+<span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;8.0.3&quot;</span>

 <span class="n">formatter</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">Formatter</span><span class="p">(</span>
    <span class="n">fmt</span><span class="o">=</span><span class="s1">&#39;</span><span class="si">%(levelname)8s</span><span class="s1">:</span><span class="si">%(filename)s</span><span class="s1">:</span><span class="si">%(lineno)d</span><span class="s1">:</span><span class="si">%(message)s</span><span class="s1">&#39;</span><span class="p">,</span>
@@ -142,6 +142,7 @@ For example
   host = imap.example.com
   user = dmarcresports@example.com
   password = $uperSecure
+   # Starting in 8.0.0, the watch option has moved to the mailbox section

   [mailbox]
   watch = True
@@ -164,15 +165,11 @@ For example
   server = localhost
   port = 514

-   [gmail_api]
-   credentials_file = /path/to/credentials.json # Get this file from console.google.com. See https://developers.google.com/identity/protocols/oauth2
-   token_file = /path/to/token.json             # This file will be generated automatically
-   scopes = https://mail.google.com/
-   include_spam_trash=True


 The full set of configuration options are:

+
 - ``general``
    - ``save_aggregate`` - bool: Save aggregate report data to Elasticsearch, Splunk and/or S3
    - ``save_forensic`` - bool: Save forensic report data to Elasticsearch, Splunk and/or S3
@@ -203,7 +200,13 @@ The full set of configuration options are:

 - ``imap``
    - ``host`` - str: The IMAP server hostname or IP address
-    - ``port`` - int: The IMAP server port (Default: 993).
+    - ``port`` - int: The IMAP server port (Default: 993)
+
+    .. note::
+      ``%`` characters must be escaped with another ``%`` character, so use ``%%`` wherever a ``%`` character is used.
+
+    .. note::
+      Starting in version 8.0.0, the ``watch`` option has been moved to the ``mailbox`` section

    .. note::
        If your host recommends another port, still try 993
@@ -260,6 +263,10 @@ The full set of configuration options are:
    - ``subject`` - str: The Subject header to use in the email (Default: parsedmarc report)
    - ``attachment`` - str: The ZIP attachment filenames
    - ``message`` - str: The email message (Default: Please see the attached parsedmarc report.)
+
+    .. note::
+      ``%`` characters must be escaped with another ``%`` character, so use ``%%`` wherever a ``%`` character is used.
+
 - ``s3``
    - ``bucket`` - str: The S3 bucket name
    - ``path`` - int: The path to upload reports to (Default: /)
@@ -650,20 +657,20 @@ Create a system user

 .. code-block:: bash

-    sudo mkdir -f /opt
-    sudo useradd parsedmarc -r -s /bin/false -b /opt
+    sudo mkdir /opt
+    sudo useradd parsedmarc -r -s /bin/false -m -b /opt


 .. code-block:: bash

    sudo -u parsedmarc -H pip3 install --user -U pip
-    sudo -u parsedmarc -H pip3 install --user -U parsedmarc
+    sudo -u parsedmarc -H pip3 install --user --no-warn-script-location -U parsedmarc

 Or, install the latest development release directly from GitHub:

 .. code-block:: bash

-    sudo -u parsedmarc -H pip3 install --user -U git+https://github.com/domainaware/parsedmarc.git
+    sudo -u parsedmarc -H pip3 install --user --no-warn-script-location -U git+https://github.com/domainaware/parsedmarc.git

 .. note::

@@ -712,7 +719,7 @@ Next, create a ``pypy3`` virtualenv for parsedmarc
    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 -H /opt/venvs/parsedmarc/bin/pip3 install --no-warn-script-location -U parsedmarc
    sudo ln -s /opt/venvs/parsedmarc/bin/parsedmarc /usr/local/bin/parsedmarc

 To upgrade ``parsedmarc`` inside the virtualenv, run:
@@ -720,13 +727,13 @@ To upgrade ``parsedmarc`` inside the virtualenv, run:

 .. code-block:: bash

-    sudo -H /opt/venvs/parsedmarc/bin/pip3 install -U parsedmarc
+    sudo -H /opt/venvs/parsedmarc/bin/pip3 install --no-warn-script-location -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
+    sudo -H /opt/venvs/parsedmarc/bin/pip3 install --no-warn-script-location -U git+https://github.com/domainaware/parsedmarc.git

 Optional dependencies
 ---------------------
@@ -750,8 +757,14 @@ tags in your DMARC record, separated by commas.
 Accessing an inbox using OWA/EWS
 --------------------------------

-Some organisations do not allow IMAP, and only support Exchange Web Services
-(EWS)/Outlook Web Access (OWA). In that case, Davmail will need to be set up
+.. note::
+
+   Starting in 8.0.0, parsedmarc supports accessing Microsoft/Office 365
+   inboxes via the Microsoft Graph API, which is preferred over Davmail.
+
+Some organisations do not allow IMAP or the Microsoft Graph API,
+and only support Exchange Web Services (EWS)/Outlook Web Access (OWA).
+In that case, Davmail will need to be set up
 as a local EWS/OWA IMAP gateway. It can even work where
 `Modern Auth/multi-factor authentication`_ is required.

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '8.0.2',
+    VERSION: '8.0.3',
    LANGUAGE: 'None',
    COLLAPSE_INDEX: false,
    BUILDER: 'html',
@@ -3,7 +3,7 @@
 <head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; parsedmarc 8.0.2 documentation</title>
+  <title>Index &mdash; parsedmarc 8.0.3 documentation</title>
      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <!--[if lt IE 9]>
@@ -27,7 +27,7 @@
            <a href="index.html" class="icon icon-home"> parsedmarc
          </a>
              <div class="version">
-                8.0.2
+                8.0.3
              </div>
 <div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -4,7 +4,7 @@
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>parsedmarc documentation - Open source DMARC report analyzer and visualizer &mdash; parsedmarc 8.0.2 documentation</title>
+  <title>parsedmarc documentation - Open source DMARC report analyzer and visualizer &mdash; parsedmarc 8.0.3 documentation</title>
      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <!--[if lt IE 9]>
@@ -28,7 +28,7 @@
            <a href="#" class="icon icon-home"> parsedmarc
          </a>
              <div class="version">
-                8.0.2
+                8.0.3
              </div>
 <div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -257,6 +257,7 @@ lookalike domain monitoring, check out <a class="reference external" href="https
 <span class="na">host</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">imap.example.com</span><span class="w"></span>
 <span class="na">user</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">dmarcresports@example.com</span><span class="w"></span>
 <span class="na">password</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">$uperSecure</span><span class="w"></span>
+<span class="c1"># Starting in 8.0.0, the watch option has moved to the mailbox section</span><span class="w"></span>

 <span class="k">[mailbox]</span><span class="w"></span>
 <span class="na">watch</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">True</span><span class="w"></span>
@@ -278,12 +279,6 @@ lookalike domain monitoring, check out <a class="reference external" href="https
 <span class="k">[syslog]</span><span class="w"></span>
 <span class="na">server</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">localhost</span><span class="w"></span>
 <span class="na">port</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">514</span><span class="w"></span>
-
-<span class="k">[gmail_api]</span><span class="w"></span>
-<span class="na">credentials_file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">/path/to/credentials.json # Get this file from console.google.com. See https://developers.google.com/identity/protocols/oauth2</span><span class="w"></span>
-<span class="na">token_file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">/path/to/token.json             # This file will be generated automatically</span><span class="w"></span>
-<span class="na">scopes</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">https://mail.google.com/</span><span class="w"></span>
-<span class="na">include_spam_trash</span><span class="o">=</span><span class="s">True</span><span class="w"></span>
 </pre></div>
 </div>
 <p>The full set of configuration options are:</p>
@@ -328,10 +323,18 @@ lookalike domain monitoring, check out <a class="reference external" href="https
 <li><dl>
 <dt><code class="docutils literal notranslate"><span class="pre">imap</span></code></dt><dd><ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">host</span></code> - str: The IMAP server hostname or IP address</p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">port</span></code> - int: The IMAP server port (Default: 993).</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">port</span></code> - int: The IMAP server port (Default: 993)</p></li>
 </ul>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
+<p><code class="docutils literal notranslate"><span class="pre">%</span></code> characters must be escaped with another <code class="docutils literal notranslate"><span class="pre">%</span></code> character, so use <code class="docutils literal notranslate"><span class="pre">%%</span></code> wherever a <code class="docutils literal notranslate"><span class="pre">%</span></code> character is used.</p>
+</div>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Starting in version 8.0.0, the <code class="docutils literal notranslate"><span class="pre">watch</span></code> option has been moved to the <code class="docutils literal notranslate"><span class="pre">mailbox</span></code> section</p>
+</div>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
 <p>If your host recommends another port, still try 993</p>
 </div>
 <ul class="simple">
@@ -400,7 +403,7 @@ lookalike domain monitoring, check out <a class="reference external" href="https
 </dd>
 </dl>
 </li>
-<li><dl class="simple">
+<li><dl>
 <dt><code class="docutils literal notranslate"><span class="pre">smtp</span></code></dt><dd><ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">host</span></code> - str: The SMTP hostname</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">port</span></code> - int: The SMTP port (Default: 25)</p></li>
@@ -414,6 +417,10 @@ lookalike domain monitoring, check out <a class="reference external" href="https
 <li><p><code class="docutils literal notranslate"><span class="pre">attachment</span></code> - str: The ZIP attachment filenames</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">message</span></code> - str: The email message (Default: Please see the attached parsedmarc report.)</p></li>
 </ul>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p><code class="docutils literal notranslate"><span class="pre">%</span></code> characters must be escaped with another <code class="docutils literal notranslate"><span class="pre">%</span></code> character, so use <code class="docutils literal notranslate"><span class="pre">%%</span></code> wherever a <code class="docutils literal notranslate"><span class="pre">%</span></code> character is used.</p>
+</div>
 </dd>
 </dl>
 </li>
@@ -768,16 +775,16 @@ sudo easy_install-3.4 pip
 <p>Python 3 installers for Windows and macOS can be found at
 <a class="reference external" href="https://www.python.org/downloads/">https://www.python.org/downloads/</a></p>
 <p>Create a system user</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo mkdir -f /opt
-sudo useradd parsedmarc -r -s /bin/false -b /opt
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo mkdir /opt
+sudo useradd parsedmarc -r -s /bin/false -m -b /opt
 </pre></div>
 </div>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo -u parsedmarc -H pip3 install --user -U pip
-sudo -u parsedmarc -H pip3 install --user -U parsedmarc
+sudo -u parsedmarc -H pip3 install --user --no-warn-script-location -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 -u parsedmarc -H pip3 install --user -U git+https://github.com/domainaware/parsedmarc.git
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo -u parsedmarc -H pip3 install --user --no-warn-script-location -U git+https://github.com/domainaware/parsedmarc.git
 </pre></div>
 </div>
 <div class="admonition note">
@@ -815,16 +822,16 @@ sudo -H pip3 install -U virtualenv
 <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 -H /opt/venvs/parsedmarc/bin/pip3 install --no-warn-script-location -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
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo -H /opt/venvs/parsedmarc/bin/pip3 install --no-warn-script-location -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
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo -H /opt/venvs/parsedmarc/bin/pip3 install --no-warn-script-location -U git+https://github.com/domainaware/parsedmarc.git
 </pre></div>
 </div>
 </section>
@@ -845,8 +852,14 @@ tags in your DMARC record, separated by commas.</p>
 </section>
 <section id="accessing-an-inbox-using-owa-ews">
 <h3>Accessing an inbox using OWA/EWS<a class="headerlink" href="#accessing-an-inbox-using-owa-ews" title="Permalink to this headline"></a></h3>
-<p>Some organisations do not allow IMAP, and only support Exchange Web Services
-(EWS)/Outlook Web Access (OWA). In that case, Davmail will need to be set up
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>Starting in 8.0.0, parsedmarc supports accessing Microsoft/Office 365
+inboxes via the Microsoft Graph API, which is preferred over Davmail.</p>
+</div>
+<p>Some organisations do not allow IMAP or the Microsoft Graph API,
+and only support Exchange Web Services (EWS)/Outlook Web Access (OWA).
+In that case, Davmail will need to be set up
 as a local EWS/OWA IMAP gateway. It can even work where
 <a class="reference external" href="http://davmail.sourceforge.net/faq.html">Modern Auth/multi-factor authentication</a> is required.</p>
 <p>To do this, download the latest <code class="docutils literal notranslate"><span class="pre">davmail-version.zip</span></code> from
@@ -1,6 +1,6 @@
 # Sphinx inventory version 2
 # Project: parsedmarc
-# Version: 8.0.2
+# Version: 8.0.3
 # The remainder of this file is compressed using zlib.
 xÚ—ÍN1Çïy
 Kí5«"U=pC�ªP<€eìÉÆÂ[�²<}ý±@€ Ö—Äkû÷Ÿñx<Þ˜Cš9N†ñT[�D»nãµúVú–ßÉr1<Oî.Í–))ÎúÞAÏ<ÜÀ`�O°ã0xi
9Ù—9Ì_\�Ýœ7²¿ƒ’×â×©éVÎY7ÅÐËÊ MPw¦01Þ²-ˆj“Ýªü#ÄÎM›Û�x y"`â×ÁðÙ¸–½;†Ç¸rÊžr…º¼cÔ[
@@ -3,7 +3,7 @@
 <head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Python Module Index &mdash; parsedmarc 8.0.2 documentation</title>
+  <title>Python Module Index &mdash; parsedmarc 8.0.3 documentation</title>
      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <!--[if lt IE 9]>
@@ -30,7 +30,7 @@
            <a href="index.html" class="icon icon-home"> parsedmarc
          </a>
              <div class="version">
-                8.0.2
+                8.0.3
              </div>
 <div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -3,7 +3,7 @@
 <head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Search &mdash; parsedmarc 8.0.2 documentation</title>
+  <title>Search &mdash; parsedmarc 8.0.3 documentation</title>
      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
    
@@ -30,7 +30,7 @@
            <a href="index.html" class="icon icon-home"> parsedmarc
          </a>
              <div class="version">
-                8.0.2
+                8.0.3
              </div>
 <div role="search">
  <form id="rtd-search-form" class="wy-form" action="#" method="get">