<spanid="cpl-mailing-email"></span><h2>cpl.mailing.email<aclass="headerlink"href="#module-cpl.mailing.email"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">cpl.mailing.email.</span></code><codeclass="sig-name descname"><spanclass="pre">EMail</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">header</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Optional</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">subject</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Optional</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">body</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Optional</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">transceiver</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Optional</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">receiver</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Optional</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl.mailing.email.EMail"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">add_header</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">header</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">str</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl.mailing.email.EMail.add_header"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds header
:param header:
:return:</p>
</dd></dl>
<dlclass="py method">
<dtid="cpl.mailing.email.EMail.add_receiver">
<codeclass="sig-name descname"><spanclass="pre">add_receiver</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">receiver</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">str</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl.mailing.email.EMail.add_receiver"title="Permalink to this definition">¶</a></dt>
<dd><p>Adds receiver
:param receiver:
:return:</p>
</dd></dl>
<dlclass="py method">
<dtid="cpl.mailing.email.EMail.body">
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">body</span></code><aclass="headerlink"href="#cpl.mailing.email.EMail.body"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="cpl.mailing.email.EMail.check_mail">
<emclass="property"><spanclass="pre">static</span></em><codeclass="sig-name descname"><spanclass="pre">check_mail</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">str</span></span></em><spanclass="sig-paren">)</span>→<spanclass="pre">bool</span><aclass="headerlink"href="#cpl.mailing.email.EMail.check_mail"title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if an email is valid
:param address:
:return:</p>
</dd></dl>
<dlclass="py method">
<dtid="cpl.mailing.email.EMail.get_content">
<codeclass="sig-name descname"><spanclass="pre">get_content</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">transceiver</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">str</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl.mailing.email.EMail.get_content"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the mail as string
:param transceiver:
:return:</p>
</dd></dl>
<dlclass="py method">
<dtid="cpl.mailing.email.EMail.header">
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">header</span></code><aclass="headerlink"href="#cpl.mailing.email.EMail.header"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="cpl.mailing.email.EMail.header_list">
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">header_list</span></code><aclass="headerlink"href="#cpl.mailing.email.EMail.header_list"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="cpl.mailing.email.EMail.receiver">
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">receiver</span></code><aclass="headerlink"href="#cpl.mailing.email.EMail.receiver"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="cpl.mailing.email.EMail.receiver_list">
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">receiver_list</span></code><aclass="headerlink"href="#cpl.mailing.email.EMail.receiver_list"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="cpl.mailing.email.EMail.subject">
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">subject</span></code><aclass="headerlink"href="#cpl.mailing.email.EMail.subject"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="py method">
<dtid="cpl.mailing.email.EMail.transceiver">
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">transceiver</span></code><aclass="headerlink"href="#cpl.mailing.email.EMail.transceiver"title="Permalink to this definition">¶</a></dt>
<spanid="cpl-mailing-email-client-abc"></span><h2>cpl.mailing.email_client_abc<aclass="headerlink"href="#module-cpl.mailing.email_client_abc"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">cpl.mailing.email_client_abc.</span></code><codeclass="sig-name descname"><spanclass="pre">EMailClientABC</span></code><aclass="headerlink"href="#cpl.mailing.email_client_abc.EMailClientABC"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">abstract</span></em><codeclass="sig-name descname"><spanclass="pre">connect</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl.mailing.email_client_abc.EMailClientABC.connect"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">abstract</span></em><codeclass="sig-name descname"><spanclass="pre">send_mail</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">email</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><aclass="reference internal"href="#cpl.mailing.email.EMail"title="cpl.mailing.email.EMail"><spanclass="pre">cpl.mailing.email.EMail</span></a></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl.mailing.email_client_abc.EMailClientABC.send_mail"title="Permalink to this definition">¶</a></dt>
<spanid="cpl-mailing-email-client-service"></span><h2>cpl.mailing.email_client_service<aclass="headerlink"href="#module-cpl.mailing.email_client_service"title="Permalink to this headline">¶</a></h2>
<codeclass="sig-name descname"><spanclass="pre">connect</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl.mailing.email_client_service.EMailClient.connect"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl.mailing.email_client_service.EMailClient.create"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">login</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl.mailing.email_client_service.EMailClient.login"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">send_mail</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">email</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><aclass="reference internal"href="#cpl.mailing.email.EMail"title="cpl.mailing.email.EMail"><spanclass="pre">cpl.mailing.email.EMail</span></a></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl.mailing.email_client_service.EMailClient.send_mail"title="Permalink to this definition">¶</a></dt>
<spanid="cpl-mailing-email-client-settings"></span><h2>cpl.mailing.email_client_settings<aclass="headerlink"href="#module-cpl.mailing.email_client_settings"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">cpl.mailing.email_client_settings.</span></code><codeclass="sig-name descname"><spanclass="pre">EMailClientSettings</span></code><aclass="headerlink"href="#cpl.mailing.email_client_settings.EMailClientSettings"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">credentials</span></code><aclass="headerlink"href="#cpl.mailing.email_client_settings.EMailClientSettings.credentials"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">from_dict</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">settings</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">dict</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl.mailing.email_client_settings.EMailClientSettings.from_dict"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">host</span></code><aclass="headerlink"href="#cpl.mailing.email_client_settings.EMailClientSettings.host"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">port</span></code><aclass="headerlink"href="#cpl.mailing.email_client_settings.EMailClientSettings.port"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">user_name</span></code><aclass="headerlink"href="#cpl.mailing.email_client_settings.EMailClientSettings.user_name"title="Permalink to this definition">¶</a></dt>
<spanid="cpl-mailing-email-client-settings-name-enum"></span><h2>cpl.mailing.email_client_settings_name_enum<aclass="headerlink"href="#module-cpl.mailing.email_client_settings_name_enum"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">cpl.mailing.email_client_settings_name_enum.</span></code><codeclass="sig-name descname"><spanclass="pre">EMailClientSettingsNameEnum</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">credentials</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'Credentials'</span></em><aclass="headerlink"href="#cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.credentials"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">host</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'Host'</span></em><aclass="headerlink"href="#cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.host"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">port</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'Port'</span></em><aclass="headerlink"href="#cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.port"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">user_name</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'UserName'</span></em><aclass="headerlink"href="#cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum.user_name"title="Permalink to this definition">¶</a></dt>