cpl.mailing

cpl.mailing.email

class cpl.mailing.email.EMail(header: Optional[list] = None, subject: Optional[str] = None, body: Optional[str] = None, transceiver: Optional[str] = None, receiver: Optional[list] = None)

Bases: object

Represents an email

header: list[str]

Header of the E-Mail

subject: str

Subject of the E-Mail

body: str

Body of the E-Mail

transceiver: str

Transceiver of the E-Mail

receiver: list[str]

Receiver of the E-Mail

add_header(header: str)

Adds header

header: str

The header of the E-Mail

add_receiver(receiver: str)

Adds receiver

receiver: str

The receiver of the E-Mail

property body

static check_mail(address: str) → bool

Checks if an email is valid

address: str

The address to check

Result if E-Mail is valid or not

get_content(transceiver: str)

Returns the mail as string

transceiver: str

The transceiver of the E-Mail

E-Mail as string

property header

property header_list

property receiver

property receiver_list

property subject

property transceiver

cpl.mailing.email_client_abc

class cpl.mailing.email_client_abc.EMailClientABC

Bases: abc.ABC

ABC of cpl.mailing.email_client_service.EMailClient

abstract connect()

Connects to server

abstract send_mail(email: cpl.mailing.email.EMail)

Sends email

email: cpl.mailing.email.EMail

Object of the E-Mail to send

cpl.mailing.email_client_service

class cpl.mailing.email_client_service.EMailClient(environment: cpl.environment.application_environment_abc.ApplicationEnvironmentABC, logger: cpl.logging.logger_abc.LoggerABC, mail_settings: cpl.mailing.email_client_settings.EMailClientSettings)

Bases: cpl.mailing.email_client_abc.EMailClientABC

Service to send emails

environment: cpl.environment.application_environment_abc.ApplicationEnvironmentABC

Environment of the application

logger: cpl.logging.logger_abc.LoggerABC

The logger to use

mail_settings: cpl.mailing.email_client_settings.EMailClientSettings

Settings for mailing

connect()

Connects to server

create()

Creates connection

login()

Login to server

send_mail(email: cpl.mailing.email.EMail)

Sends email

email: cpl.mailing.email.EMail

Object of the E-Mail to send

cpl.mailing.email_client_settings

class cpl.mailing.email_client_settings.EMailClientSettings

Bases: cpl.configuration.configuration_model_abc.ConfigurationModelABC

Representation of mailing settings

property credentials

from_dict(settings: dict)

Converts attributes to dict

settings: dict

property host

property port

property user_name

cpl.mailing.email_client_settings_name_enum

class cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum(value)

Bases: enum.Enum

An enumeration.

credentials = 'Credentials'

host = 'Host'

port = 'Port'

user_name = 'UserName'