389 lines
35 KiB
HTML
389 lines
35 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<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 — 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]>
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
|
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
<script src="_static/jquery.js"></script>
|
|
<script src="_static/underscore.js"></script>
|
|
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
|
<script src="_static/doctools.js"></script>
|
|
<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" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
<a href="index.html" class="icon icon-home"> Common Python Library
|
|
</a>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</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>
|
|
</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_query.html">Query Reference</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="index.html">Common Python Library</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
|
<li><a href="cpl_core.html">API Reference</a> »</li>
|
|
<li>cpl_core.mailing</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="_sources/cpl_core.mailing.rst.txt" rel="nofollow"> View page source</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<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="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>
|
|
<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">
|
|
<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>
|
|
</dd>
|
|
<dt>body: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Body of the E-Mail</p>
|
|
</dd>
|
|
<dt>transceiver: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>Transceiver of the E-Mail</p>
|
|
</dd>
|
|
<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>
|
|
<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">
|
|
<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>
|
|
|
|
<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">
|
|
<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>
|
|
|
|
<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>
|
|
<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">→</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">
|
|
<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></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">
|
|
<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></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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<dd><p>Sends email</p>
|
|
<blockquote>
|
|
<div><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>
|
|
|
|
</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>
|
|
<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">
|
|
<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>
|
|
</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>
|
|
</dd>
|
|
</dl>
|
|
</div></blockquote>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<dd><p>Sends email</p>
|
|
<blockquote>
|
|
<div><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>
|
|
|
|
</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>
|
|
<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>
|
|
<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>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<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>
|
|
</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>
|
|
<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>
|
|
<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>
|
|
<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"></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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</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>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2021, Sven Heidemann.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |