Updated docs

2023-02-20 15:55:20 +01:00
parent 48d0daabf5
commit 9e28dce5ce
632 changed files with 10917 additions and 6775 deletions
--- a/docs/build/html/cpl_core.mailing.html
+++ b/docs/build/html/cpl_core.mailing.html
@@ -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>cpl_core.mailing &mdash; Common Python Library  documentation</title>
+  <title>cpl_core.mailing package &mdash; Common Python Library  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]>
@@ -19,8 +19,8 @@
    <script src="_static/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="cpl_core.pipes" href="cpl_core.pipes.html" />
-    <link rel="prev" title="cpl_core.logging" href="cpl_core.logging.html" /> 
+    <link rel="next" title="cpl_core.pipes package" href="cpl_core.pipes.html" />
+    <link rel="prev" title="cpl_core.logging package" href="cpl_core.logging.html" /> 
 </head>

 <body class="wy-body-for-nav"> 
@@ -44,27 +44,32 @@
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
 <li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="cpl_core.html">API reference</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html">cpl_core.logging</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.mailing</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email">cpl_core.mailing.email</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_abc">cpl_core.mailing.email_client_abc</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_service">cpl_core.mailing.email_client_service</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_settings">cpl_core.mailing.email_client_settings</a></li>
-<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_settings_name_enum">cpl_core.mailing.email_client_settings_name_enum</a></li>
+<li class="toctree-l2"><a class="reference internal" href="cpl_core.application.html">cpl_core.application package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="cpl_core.configuration.html">cpl_core.configuration package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="cpl_core.database.html">cpl_core.database package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="cpl_core.dependency_injection.html">cpl_core.dependency_injection package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="cpl_core.environment.html">cpl_core.environment package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="cpl_core.logging.html">cpl_core.logging package</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.mailing package</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email">cpl_core.mailing.email module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_abc">cpl_core.mailing.email_client_abc module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_service">cpl_core.mailing.email_client_service module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_settings">cpl_core.mailing.email_client_settings module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing.email_client_settings_name_enum">cpl_core.mailing.email_client_settings_name_enum module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing">Module contents</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
+<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="cpl_core.utils.html">cpl_core.utils package</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">cpl_discord package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
 </ul>
@@ -84,7 +89,7 @@
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
          <li><a href="cpl_core.html">API reference</a> &raquo;</li>
-      <li>cpl_core.mailing</li>
+      <li>cpl_core.mailing package</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/cpl_core.mailing.rst.txt" rel="nofollow"> View page source</a>
      </li>
@@ -94,17 +99,20 @@
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
-  <section id="cpl-core-mailing">
-<h1>cpl_core.mailing<a class="headerlink" href="#cpl-core-mailing" title="Permalink to this heading"></a></h1>
+  <section id="cpl-core-mailing-package">
+<h1>cpl_core.mailing package<a class="headerlink" href="#cpl-core-mailing-package" title="Permalink to this heading"></a></h1>
+<section id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
+</section>
 <section id="module-cpl_core.mailing.email">
-<span id="cpl-core-mailing-email"></span><h2>cpl_core.mailing.email<a class="headerlink" href="#module-cpl_core.mailing.email" title="Permalink to this heading"></a></h2>
+<span id="cpl-core-mailing-email-module"></span><h2>cpl_core.mailing.email module<a class="headerlink" href="#module-cpl_core.mailing.email" title="Permalink to this heading"></a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="cpl_core.mailing.email.EMail">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.mailing.email.</span></span><span class="sig-name descname"><span class="pre">EMail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transceiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">receiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email.EMail" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <p>Represents an email</p>
-<blockquote>
-<div><dl class="simple">
+<dl class="simple">
+<dt>Parameter:</dt><dd><dl class="simple">
 <dt>header: list[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</dt><dd><p>Header of the E-Mail</p>
 </dd>
 <dt>subject: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Subject of the E-Mail</p>
@@ -116,29 +124,32 @@
 <dt>receiver: list[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</dt><dd><p>Receiver of the E-Mail</p>
 </dd>
 </dl>
-</div></blockquote>
+</dd>
+</dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="cpl_core.mailing.email.EMail.add_header">
 <span class="sig-name descname"><span class="pre">add_header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email.EMail.add_header" title="Permalink to this definition"></a></dt>
 <dd><p>Adds header</p>
-<blockquote>
-<div><dl class="simple">
+<dl class="simple">
+<dt>Parameter:</dt><dd><dl class="simple">
 <dt>header: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The header of the E-Mail</p>
 </dd>
 </dl>
-</div></blockquote>
+</dd>
+</dl>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="cpl_core.mailing.email.EMail.add_receiver">
 <span class="sig-name descname"><span class="pre">add_receiver</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">receiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email.EMail.add_receiver" title="Permalink to this definition"></a></dt>
 <dd><p>Adds receiver</p>
-<blockquote>
-<div><dl class="simple">
+<dl class="simple">
+<dt>Parameter:</dt><dd><dl class="simple">
 <dt>receiver: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The receiver of the E-Mail</p>
 </dd>
 </dl>
-</div></blockquote>
+</dd>
+</dl>
 </dd></dl>

 <dl class="py property">
@@ -150,30 +161,30 @@
 <dt class="sig sig-object py" id="cpl_core.mailing.email.EMail.check_mail">
 <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">check_mail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_core.mailing.email.EMail.check_mail" title="Permalink to this definition"></a></dt>
 <dd><p>Checks if an email is valid</p>
-<blockquote>
-<div><dl class="simple">
+<dl class="simple">
+<dt>Parameter:</dt><dd><dl class="simple">
 <dt>address: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The address to check</p>
 </dd>
 </dl>
-</div></blockquote>
-<blockquote>
-<div><p>Result if E-Mail is valid or not</p>
-</div></blockquote>
+</dd>
+<dt>Returns:</dt><dd><p>Result if E-Mail is valid or not</p>
+</dd>
+</dl>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="cpl_core.mailing.email.EMail.get_content">
 <span class="sig-name descname"><span class="pre">get_content</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">transceiver</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email.EMail.get_content" title="Permalink to this definition"></a></dt>
 <dd><p>Returns the mail as string</p>
-<blockquote>
-<div><dl class="simple">
+<dl class="simple">
+<dt>Parameter:</dt><dd><dl class="simple">
 <dt>transceiver: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The transceiver of the E-Mail</p>
 </dd>
 </dl>
-</div></blockquote>
-<blockquote>
-<div><p>E-Mail as string</p>
-</div></blockquote>
+</dd>
+<dt>Returns:</dt><dd><p>E-Mail as string</p>
+</dd>
+</dl>
 </dd></dl>

 <dl class="py property">
@@ -210,7 +221,7 @@

 </section>
 <section id="module-cpl_core.mailing.email_client_abc">
-<span id="cpl-core-mailing-email-client-abc"></span><h2>cpl_core.mailing.email_client_abc<a class="headerlink" href="#module-cpl_core.mailing.email_client_abc" title="Permalink to this heading"></a></h2>
+<span id="cpl-core-mailing-email-client-abc-module"></span><h2>cpl_core.mailing.email_client_abc module<a class="headerlink" href="#module-cpl_core.mailing.email_client_abc" title="Permalink to this heading"></a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="cpl_core.mailing.email_client_abc.EMailClientABC">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.mailing.email_client_abc.</span></span><span class="sig-name descname"><span class="pre">EMailClientABC</span></span><a class="headerlink" href="#cpl_core.mailing.email_client_abc.EMailClientABC" title="Permalink to this definition"></a></dt>
@@ -226,26 +237,27 @@
 <dt class="sig sig-object py" id="cpl_core.mailing.email_client_abc.EMailClientABC.send_mail">
 <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">send_mail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.mailing.email.EMail" title="cpl_core.mailing.email.EMail"><span class="pre">EMail</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email_client_abc.EMailClientABC.send_mail" title="Permalink to this definition"></a></dt>
 <dd><p>Sends email</p>
-<blockquote>
-<div><dl class="simple">
+<dl class="simple">
+<dt>Parameter:</dt><dd><dl class="simple">
 <dt>email: <a class="reference internal" href="#cpl_core.mailing.email.EMail" title="cpl_core.mailing.email.EMail"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.mailing.email.EMail</span></code></a></dt><dd><p>Object of the E-Mail to send</p>
 </dd>
 </dl>
-</div></blockquote>
+</dd>
+</dl>
 </dd></dl>

 </dd></dl>

 </section>
 <section id="module-cpl_core.mailing.email_client_service">
-<span id="cpl-core-mailing-email-client-service"></span><h2>cpl_core.mailing.email_client_service<a class="headerlink" href="#module-cpl_core.mailing.email_client_service" title="Permalink to this heading"></a></h2>
+<span id="cpl-core-mailing-email-client-service-module"></span><h2>cpl_core.mailing.email_client_service module<a class="headerlink" href="#module-cpl_core.mailing.email_client_service" title="Permalink to this heading"></a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="cpl_core.mailing.email_client_service.EMailClient">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.mailing.email_client_service.</span></span><span class="sig-name descname"><span class="pre">EMailClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">environment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">ApplicationEnvironmentABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_abc.LoggerABC" title="cpl_core.logging.logger_abc.LoggerABC"><span class="pre">LoggerABC</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">mail_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.mailing.email_client_settings.EMailClientSettings" title="cpl_core.mailing.email_client_settings.EMailClientSettings"><span class="pre">EMailClientSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email_client_service.EMailClient" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#cpl_core.mailing.email_client_abc.EMailClientABC" title="cpl_core.mailing.email_client_abc.EMailClientABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EMailClientABC</span></code></a></p>
 <p>Service to send emails</p>
-<blockquote>
-<div><dl class="simple">
+<dl class="simple">
+<dt>Parameter:</dt><dd><dl class="simple">
 <dt>environment: <a class="reference internal" href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC</span></code></a></dt><dd><p>Environment of the application</p>
 </dd>
 <dt>logger: <a class="reference internal" href="cpl_core.logging.html#cpl_core.logging.logger_abc.LoggerABC" title="cpl_core.logging.logger_abc.LoggerABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.logging.logger_abc.LoggerABC</span></code></a></dt><dd><p>The logger to use</p>
@@ -253,7 +265,8 @@
 <dt>mail_settings: <a class="reference internal" href="#cpl_core.mailing.email_client_settings.EMailClientSettings" title="cpl_core.mailing.email_client_settings.EMailClientSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.mailing.email_client_settings.EMailClientSettings</span></code></a></dt><dd><p>Settings for mailing</p>
 </dd>
 </dl>
-</div></blockquote>
+</dd>
+</dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="cpl_core.mailing.email_client_service.EMailClient.connect">
 <span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email_client_service.EMailClient.connect" title="Permalink to this definition"></a></dt>
@@ -276,19 +289,20 @@
 <dt class="sig sig-object py" id="cpl_core.mailing.email_client_service.EMailClient.send_mail">
 <span class="sig-name descname"><span class="pre">send_mail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">email</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#cpl_core.mailing.email.EMail" title="cpl_core.mailing.email.EMail"><span class="pre">EMail</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email_client_service.EMailClient.send_mail" title="Permalink to this definition"></a></dt>
 <dd><p>Sends email</p>
-<blockquote>
-<div><dl class="simple">
+<dl class="simple">
+<dt>Parameter:</dt><dd><dl class="simple">
 <dt>email: <a class="reference internal" href="#cpl_core.mailing.email.EMail" title="cpl_core.mailing.email.EMail"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.mailing.email.EMail</span></code></a></dt><dd><p>Object of the E-Mail to send</p>
 </dd>
 </dl>
-</div></blockquote>
+</dd>
+</dl>
 </dd></dl>

 </dd></dl>

 </section>
 <section id="module-cpl_core.mailing.email_client_settings">
-<span id="cpl-core-mailing-email-client-settings"></span><h2>cpl_core.mailing.email_client_settings<a class="headerlink" href="#module-cpl_core.mailing.email_client_settings" title="Permalink to this heading"></a></h2>
+<span id="cpl-core-mailing-email-client-settings-module"></span><h2>cpl_core.mailing.email_client_settings module<a class="headerlink" href="#module-cpl_core.mailing.email_client_settings" title="Permalink to this heading"></a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="cpl_core.mailing.email_client_settings.EMailClientSettings">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.mailing.email_client_settings.</span></span><span class="sig-name descname"><span class="pre">EMailClientSettings</span></span><a class="headerlink" href="#cpl_core.mailing.email_client_settings.EMailClientSettings" title="Permalink to this definition"></a></dt>
@@ -303,9 +317,10 @@
 <dt class="sig sig-object py" id="cpl_core.mailing.email_client_settings.EMailClientSettings.from_dict">
 <span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email_client_settings.EMailClientSettings.from_dict" title="Permalink to this definition"></a></dt>
 <dd><p>Converts attributes to dict</p>
-<blockquote>
-<div><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
-</div></blockquote>
+<dl class="simple">
+<dt>Parameter:</dt><dd><p>settings: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
+</dd>
+</dl>
 </dd></dl>

 <dl class="py property">
@@ -327,7 +342,7 @@

 </section>
 <section id="module-cpl_core.mailing.email_client_settings_name_enum">
-<span id="cpl-core-mailing-email-client-settings-name-enum"></span><h2>cpl_core.mailing.email_client_settings_name_enum<a class="headerlink" href="#module-cpl_core.mailing.email_client_settings_name_enum" title="Permalink to this heading"></a></h2>
+<span id="cpl-core-mailing-email-client-settings-name-enum-module"></span><h2>cpl_core.mailing.email_client_settings_name_enum module<a class="headerlink" href="#module-cpl_core.mailing.email_client_settings_name_enum" title="Permalink to this heading"></a></h2>
 <dl class="py class">
 <dt class="sig sig-object py" id="cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.mailing.email_client_settings_name_enum.</span></span><span class="sig-name descname"><span class="pre">EMailClientSettingsNameEnum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum" title="Permalink to this definition"></a></dt>
@@ -355,6 +370,47 @@

 </dd></dl>

+</section>
+<section id="module-cpl_core.mailing">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_core.mailing" title="Permalink to this heading"></a></h2>
+<section id="cpl-core-cpl-core">
+<h3>cpl-core CPL core<a class="headerlink" href="#cpl-core-cpl-core" title="Permalink to this heading"></a></h3>
+<p>CPL core package</p>
+<dl class="field-list simple">
+<dt class="field-odd">copyright</dt>
+<dd class="field-odd"><ol class="loweralpha simple" start="3">
+<li><p>2020 - 2023 sh-edraft.de</p></li>
+</ol>
+</dd>
+<dt class="field-even">license</dt>
+<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
+</dd>
+</dl>
+<dl class="py class">
+<dt class="sig sig-object py" id="cpl_core.mailing.VersionInfo">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_core.mailing.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.VersionInfo" title="Permalink to this definition"></a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="cpl_core.mailing.VersionInfo.major">
+<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_core.mailing.VersionInfo.major" title="Permalink to this definition"></a></dt>
+<dd><p>Alias for field number 0</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="cpl_core.mailing.VersionInfo.micro">
+<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_core.mailing.VersionInfo.micro" title="Permalink to this definition"></a></dt>
+<dd><p>Alias for field number 2</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="cpl_core.mailing.VersionInfo.minor">
+<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_core.mailing.VersionInfo.minor" title="Permalink to this definition"></a></dt>
+<dd><p>Alias for field number 1</p>
+</dd></dl>
+
+</dd></dl>
+
+</section>
 </section>
 </section>

@@ -362,8 +418,8 @@
           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="cpl_core.logging.html" class="btn btn-neutral float-left" title="cpl_core.logging" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="cpl_core.pipes.html" class="btn btn-neutral float-right" title="cpl_core.pipes" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="cpl_core.logging.html" class="btn btn-neutral float-left" title="cpl_core.logging package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="cpl_core.pipes.html" class="btn btn-neutral float-right" title="cpl_core.pipes package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>