Added cpl-mail
Some checks failed
Build on push / core (push) Failing after 9s
Build on push / mail (push) Has been cancelled
Build on push / translation (push) Has been cancelled
Build on push / prepare (push) Has been cancelled
Build on push / query (push) Has been cancelled

This commit is contained in:
2025-09-15 18:33:06 +02:00
parent 784632a0b4
commit aac038ef63
39 changed files with 313 additions and 277 deletions

View File

@@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_core.mailing package &mdash; Common Python Library documentation</title>
<title>cpl_mail 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]>
@@ -56,31 +56,31 @@
<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.log.html">cpl_core.log package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_core.mailing package</a><ul>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_mail 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><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.mailing.email.EMail"><code class="docutils literal notranslate"><span class="pre">EMail</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_mail.email">cpl_mail.email module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_mail.email.EMail"><code class="docutils literal notranslate"><span class="pre">EMail</span></code></a></li>
</ul>
</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><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.mailing.email_client_abc.EMailClientABC"><code class="docutils literal notranslate"><span class="pre">EMailClientABC</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_mail.email_client_abc">cpl_mail.email_client_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_mail.email_client_abc.EMailClientABC"><code class="docutils literal notranslate"><span class="pre">EMailClientABC</span></code></a></li>
</ul>
</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><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.mailing.email_client_service.EMailClient"><code class="docutils literal notranslate"><span class="pre">EMailClient</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_mail.email_client_service">cpl_mail.email_client_service module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_mail.email_client_service.EMailClient"><code class="docutils literal notranslate"><span class="pre">EMailClient</span></code></a></li>
</ul>
</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><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.mailing.email_client_settings.EMailClientSettings"><code class="docutils literal notranslate"><span class="pre">EMailClientSettings</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_mail.email_client_settings">cpl_mail.email_client_settings module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_mail.email_client_settings.EMailClientSettings"><code class="docutils literal notranslate"><span class="pre">EMailClientSettings</span></code></a></li>
</ul>
</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><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">EMailClientSettingsNameEnum</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_mail.email_client_settings_name_enum">cpl_mail.email_client_settings_name_enum module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum"><code class="docutils literal notranslate"><span class="pre">EMailClientSettingsNameEnum</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_core.mailing">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_mail">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-core-cpl-core">cpl-core CPL core</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_core.mailing.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_mail.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
@@ -110,9 +110,9 @@
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpl_core.html">API reference</a></li>
<li class="breadcrumb-item active">cpl_core.mailing package</li>
<li class="breadcrumb-item active">cpl_mail package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_core.mailing.rst.txt" rel="nofollow"> View page source</a>
<a href="_sources/cpl_mail.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
@@ -121,15 +121,15 @@
<div itemprop="articleBody">
<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>
<h1>cpl_mail 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-module"></span><h2>cpl_core.mailing.email module<a class="headerlink" href="#module-cpl_core.mailing.email" title="Permalink to this heading"></a></h2>
<section id="module-cpl_mail.email">
<span id="cpl-core-mailing-email-module"></span><h2>cpl_mail.email module<a class="headerlink" href="#module-cpl_mail.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">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="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">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="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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>
<dt class="sig sig-object py" id="cpl_mail.email.EMail">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_mail.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">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="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">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="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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_mail.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>
<dl class="simple">
@@ -148,8 +148,8 @@
</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>
<dt class="sig sig-object py" id="cpl_mail.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_mail.email.EMail.add_header" title="Permalink to this definition"></a></dt>
<dd><p>Adds header</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -161,8 +161,8 @@
</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>
<dt class="sig sig-object py" id="cpl_mail.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_mail.email.EMail.add_receiver" title="Permalink to this definition"></a></dt>
<dd><p>Adds receiver</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -174,13 +174,13 @@
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.mailing.email.EMail.body">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">body</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.mailing.email.EMail.body" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email.EMail.body">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">body</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email.EMail.body" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<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>
<dt class="sig sig-object py" id="cpl_mail.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_mail.email.EMail.check_mail" title="Permalink to this definition"></a></dt>
<dd><p>Checks if an email is valid</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -194,8 +194,8 @@
</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>
<dt class="sig sig-object py" id="cpl_mail.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_mail.email.EMail.get_content" title="Permalink to this definition"></a></dt>
<dd><p>Returns the mail as string</p>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -209,58 +209,58 @@
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.mailing.email.EMail.header">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">header</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.mailing.email.EMail.header" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email.EMail.header">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">header</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email.EMail.header" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.mailing.email.EMail.header_list">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">header_list</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </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></em><a class="headerlink" href="#cpl_core.mailing.email.EMail.header_list" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email.EMail.header_list">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">header_list</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </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></em><a class="headerlink" href="#cpl_mail.email.EMail.header_list" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.mailing.email.EMail.receiver">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">receiver</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.mailing.email.EMail.receiver" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email.EMail.receiver">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">receiver</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email.EMail.receiver" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.mailing.email.EMail.receiver_list">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">receiver_list</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </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></em><a class="headerlink" href="#cpl_core.mailing.email.EMail.receiver_list" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email.EMail.receiver_list">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">receiver_list</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </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></em><a class="headerlink" href="#cpl_mail.email.EMail.receiver_list" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.mailing.email.EMail.subject">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">subject</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.mailing.email.EMail.subject" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email.EMail.subject">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">subject</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email.EMail.subject" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.mailing.email.EMail.transceiver">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">transceiver</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.mailing.email.EMail.transceiver" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email.EMail.transceiver">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">transceiver</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email.EMail.transceiver" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-cpl_core.mailing.email_client_abc">
<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>
<section id="module-cpl_mail.email_client_abc">
<span id="cpl-core-mailing-email-client-abc-module"></span><h2>cpl_mail.email_client_abc module<a class="headerlink" href="#module-cpl_mail.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>
<dt class="sig sig-object py" id="cpl_mail.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_mail.email_client_abc.</span></span><span class="sig-name descname"><span class="pre">EMailClientABC</span></span><a class="headerlink" href="#cpl_mail.email_client_abc.EMailClientABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
<p>ABC of <a class="reference internal" href="#cpl_core.mailing.email_client_service.EMailClient" title="cpl_core.mailing.email_client_service.EMailClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.mailing.email_client_service.EMailClient</span></code></a></p>
<p>ABC of <a class="reference internal" href="#cpl_mail.email_client_service.EMailClient" title="cpl_mail.email_client_service.EMailClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_mail.email_client_service.EMailClient</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.mailing.email_client_abc.EMailClientABC.connect">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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_abc.EMailClientABC.connect" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email_client_abc.EMailClientABC.connect">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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_mail.email_client_abc.EMailClientABC.connect" title="Permalink to this definition"></a></dt>
<dd><p>Connects to server</p>
</dd></dl>
<dl class="py method">
<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>
<dt class="sig sig-object py" id="cpl_mail.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_mail.email.EMail" title="cpl_mail.email.EMail"><span class="pre">EMail</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email_client_abc.EMailClientABC.send_mail" title="Permalink to this definition"></a></dt>
<dd><p>Sends email</p>
<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>
<dt>email: <a class="reference internal" href="#cpl_mail.email.EMail" title="cpl_mail.email.EMail"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_mail.email.EMail</span></code></a></dt><dd><p>Object of the E-Mail to send</p>
</dd>
</dl>
</dd>
@@ -270,12 +270,12 @@
</dd></dl>
</section>
<section id="module-cpl_core.mailing.email_client_service">
<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>
<section id="module-cpl_mail.email_client_service">
<span id="cpl-core-mailing-email-client-service-module"></span><h2>cpl_mail.email_client_service module<a class="headerlink" href="#module-cpl_mail.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.log.html#cpl_core.log.logger_abc.LoggerABC" title="cpl_core.log.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>
<dt class="sig sig-object py" id="cpl_mail.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_mail.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.log.html#cpl_core.log.logger_abc.LoggerABC" title="cpl_core.log.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_mail.email_client_settings.EMailClientSettings" title="cpl_mail.email_client_settings.EMailClientSettings"><span class="pre">EMailClientSettings</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email_client_service.EMailClient" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_mail.email_client_abc.EMailClientABC" title="cpl_mail.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>
<dl class="simple">
<dt>Parameter:</dt><dd><dl class="simple">
@@ -283,36 +283,36 @@
</dd>
<dt>logger: <a class="reference internal" href="cpl_core.log.html#cpl_core.log.logger_abc.LoggerABC" title="cpl_core.log.logger_abc.LoggerABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_core.log.logger_abc.LoggerABC</span></code></a></dt><dd><p>The logger to use</p>
</dd>
<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>
<dt>mail_settings: <a class="reference internal" href="#cpl_mail.email_client_settings.EMailClientSettings" title="cpl_mail.email_client_settings.EMailClientSettings"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_mail.email_client_settings.EMailClientSettings</span></code></a></dt><dd><p>Settings for mailing</p>
</dd>
</dl>
</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>
<dt class="sig sig-object py" id="cpl_mail.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_mail.email_client_service.EMailClient.connect" title="Permalink to this definition"></a></dt>
<dd><p>Connects to server</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.mailing.email_client_service.EMailClient.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email_client_service.EMailClient.create" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email_client_service.EMailClient.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email_client_service.EMailClient.create" title="Permalink to this definition"></a></dt>
<dd><p>Creates connection</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_core.mailing.email_client_service.EMailClient.login">
<span class="sig-name descname"><span class="pre">login</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_core.mailing.email_client_service.EMailClient.login" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email_client_service.EMailClient.login">
<span class="sig-name descname"><span class="pre">login</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email_client_service.EMailClient.login" title="Permalink to this definition"></a></dt>
<dd><p>Login to server</p>
</dd></dl>
<dl class="py method">
<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>
<dt class="sig sig-object py" id="cpl_mail.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_mail.email.EMail" title="cpl_mail.email.EMail"><span class="pre">EMail</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_mail.email_client_service.EMailClient.send_mail" title="Permalink to this definition"></a></dt>
<dd><p>Sends email</p>
<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>
<dt>email: <a class="reference internal" href="#cpl_mail.email.EMail" title="cpl_mail.email.EMail"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_mail.email.EMail</span></code></a></dt><dd><p>Object of the E-Mail to send</p>
</dd>
</dl>
</dd>
@@ -322,68 +322,68 @@
</dd></dl>
</section>
<section id="module-cpl_core.mailing.email_client_settings">
<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>
<section id="module-cpl_mail.email_client_settings">
<span id="cpl-core-mailing-email-client-settings-module"></span><h2>cpl_mail.email_client_settings module<a class="headerlink" href="#module-cpl_mail.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><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">user_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">credentials</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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_client_settings.EMailClientSettings" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.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_mail.email_client_settings.</span></span><span class="sig-name descname"><span class="pre">EMailClientSettings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">user_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">credentials</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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_mail.email_client_settings.EMailClientSettings" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_core.configuration.html#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConfigurationModelABC</span></code></a></p>
<p>Representation of mailing settings</p>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.mailing.email_client_settings.EMailClientSettings.credentials">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.mailing.email_client_settings.EMailClientSettings.credentials" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email_client_settings.EMailClientSettings.credentials">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email_client_settings.EMailClientSettings.credentials" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.mailing.email_client_settings.EMailClientSettings.host">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.mailing.email_client_settings.EMailClientSettings.host" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email_client_settings.EMailClientSettings.host">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email_client_settings.EMailClientSettings.host" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.mailing.email_client_settings.EMailClientSettings.port">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#cpl_core.mailing.email_client_settings.EMailClientSettings.port" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email_client_settings.EMailClientSettings.port">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#cpl_mail.email_client_settings.EMailClientSettings.port" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_core.mailing.email_client_settings.EMailClientSettings.user_name">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_core.mailing.email_client_settings.EMailClientSettings.user_name" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email_client_settings.EMailClientSettings.user_name">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#cpl_mail.email_client_settings.EMailClientSettings.user_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-cpl_core.mailing.email_client_settings_name_enum">
<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>
<section id="module-cpl_mail.email_client_settings_name_enum">
<span id="cpl-core-mailing-email-client-settings-name-enum-module"></span><h2>cpl_mail.email_client_settings_name_enum module<a class="headerlink" href="#module-cpl_mail.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>
<dt class="sig sig-object py" id="cpl_mail.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_mail.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_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>An enumeration.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.credentials">
<span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Credentials'</span></em><a class="headerlink" href="#cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.credentials" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.credentials">
<span class="sig-name descname"><span class="pre">credentials</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Credentials'</span></em><a class="headerlink" href="#cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.credentials" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.host">
<span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Host'</span></em><a class="headerlink" href="#cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.host" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.host">
<span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Host'</span></em><a class="headerlink" href="#cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.host" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.port">
<span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Port'</span></em><a class="headerlink" href="#cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.port" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.port">
<span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'Port'</span></em><a class="headerlink" href="#cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.port" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.user_name">
<span class="sig-name descname"><span class="pre">user_name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UserName'</span></em><a class="headerlink" href="#cpl_core.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.user_name" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.user_name">
<span class="sig-name descname"><span class="pre">user_name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'UserName'</span></em><a class="headerlink" href="#cpl_mail.email_client_settings_name_enum.EMailClientSettingsNameEnum.user_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</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="module-cpl_mail">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_mail" 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>
@@ -399,24 +399,24 @@
</dl>
</section>
<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>
<dt class="sig sig-object py" id="cpl_mail.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_mail.</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_mail.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>
<dt class="sig sig-object py" id="cpl_mail.VersionInfo.major">
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_mail.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>
<dt class="sig sig-object py" id="cpl_mail.VersionInfo.micro">
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_mail.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>
<dt class="sig sig-object py" id="cpl_mail.VersionInfo.minor">
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_mail.VersionInfo.minor" title="Permalink to this definition"></a></dt>
<dd><p>Alias for field number 1</p>
</dd></dl>