orionis.foundation.config.mail.Smtp

ORIONIS API REFERENCE

Modules Classes Names

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

class documentation

class Smtp(BaseEntity): (source)

View In Hierarchy

Represent SMTP configuration settings.

Parameters
driver	The driver type for the mail transport. Default is "smtp".
url	Full URL for the SMTP service. Default is from 'MAIL_URL'.
host	Hostname of the SMTP server. Default is from 'MAIL_HOST'.
port	Port number for SMTP communication. Default is from 'MAIL_PORT' or 587.
encryption	Encryption type for secure communication. Default is from 'MAIL_ENCRYPTION' or 'TLS'.
username	Username for SMTP authentication. Default is from 'MAIL_USERNAME'.
password	Password for SMTP authentication. Default is from 'MAIL_PASSWORD'.
timeout	Connection timeout in seconds. Default is None.

Raises
`TypeError`	If any attribute does not meet its structural type requirements.

Method	`__post_init__`	Validate the structural types of the SMTP settings.
Class Variable	`driver`	Undocumented
Class Variable	`encryption`	Undocumented
Class Variable	`host`	Undocumented
Class Variable	`password`	Undocumented
Class Variable	`port`	Undocumented
Class Variable	`timeout`	Undocumented
Class Variable	`url`	Undocumented
Class Variable	`username`	Undocumented

Inherited from BaseEntity:

Class Method	`_cachedFieldMetadata`	Retrieve field definitions and normalized types cached by class.
Method	`getFields`	Describe field names, normalized types, defaults, and metadata.
Method	`toDict`	Convert the dataclass instance to a recursively copied dictionary.
Class Variable	`__slots__`	Undocumented

def __post_init__(self): (source) ¶

overrides orionis.support.entities.BaseEntity.__post_init__

Validate the structural types of the SMTP settings.

This method ensures that the 'driver' is set to 'smtp' and that all other attributes conform to their expected types. It allows 'timeout' to be None.

Returns
`None`	Keep structurally valid settings for transport-level validation.

Raises
`TypeError`	If any attribute does not meet its structural type requirements.

driver: str, default "smtp" = (source) ¶

Undocumented

encryption: str = (source) ¶

Undocumented

host: str = (source) ¶

Undocumented

password: str = (source) ¶

Undocumented

port: int = (source) ¶

Undocumented

timeout: int | None, default None = (source) ¶

Undocumented

url: str = (source) ¶

Undocumented

username: str = (source) ¶

Undocumented