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.
class documentation
Represent SMTP configuration settings.
| Raises | |
TypeError | If any attribute does not meet its structural type requirements. |
| Method | __post |
Validate the structural types of the SMTP settings. |
| Instance Variable | driver |
The driver type for the mail transport. Default is "smtp". |
| Instance Variable | encryption |
Encryption type for secure communication. Default is from 'MAIL_ENCRYPTION' or 'TLS'. |
| Instance Variable | host |
Hostname of the SMTP server. Default is from 'MAIL_HOST'. |
| Instance Variable | password |
Password for SMTP authentication. Default is from 'MAIL_PASSWORD'. |
| Instance Variable | port |
Port number for SMTP communication. Default is from 'MAIL_PORT' or 587. |
| Instance Variable | timeout |
Connection timeout in seconds. Default is None. |
| Instance Variable | url |
Full URL for the SMTP service. Default is from 'MAIL_URL'. |
| Instance Variable | username |
Username for SMTP authentication. Default is from 'MAIL_USERNAME'. |
Inherited from BaseEntity:
| Class Method | _cached |
Retrieve field definitions and normalized types cached by class. |
| Method | __init__ |
Initialize declared fields and public extra attributes. |
| Method | _dynamic |
Return public instance attributes that are not declared fields. |
| Method | _validate |
Validate names and storage for public extra attributes. |
| Method | get |
Describe declared fields and, optionally, dynamic attributes. |
| Method | to |
Return a recursively copied dictionary of declared and extra values. |
| Class Variable | __slots__ |
Declare that this class introduces no additional instance slots. |
| Class Variable | _orionis |
Cache declared fields and normalized type names for each concrete class. |
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. |