ORIONIS API REFERENCE

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

class SmtpSettings: (source)

View In Hierarchy

Store effective SMTP settings without exposing credentials in repr.

Class Method fromConfig Resolve URL precedence and validate the effective SMTP settings.
Instance Variable encryption Negotiated transport security mode.
Instance Variable host Effective SMTP hostname.
Instance Variable password Authentication secret, empty when authentication is disabled.
Instance Variable port Effective TCP port between 1 and 65535.
Instance Variable sensitive Values redacted from transport diagnostics.
Instance Variable timeout Positive socket timeout in seconds, or None for an unbounded wait.
Instance Variable username Authentication user, empty when authentication is disabled.
def fromConfig(cls, config: Mapping[str, object]) -> Self: (source)

Resolve URL precedence and validate the effective SMTP settings.

Parameters
config:collections.abc.Mapping[str, object]One normalized mailer, without environment lookups.
Returns
typing.SelfValidated immutable connection options.
Raises
orionis.mail.exceptions.MailConfigurationExceptionIf endpoint, encryption, credentials, timeout, or URL is invalid.

Negotiated transport security mode.

Effective SMTP hostname.

password: str = (source)

Authentication secret, empty when authentication is disabled.

Effective TCP port between 1 and 65535.

sensitive: tuple[str, ...] = (source)

Values redacted from transport diagnostics.

timeout: int | None = (source)

Positive socket timeout in seconds, or None for an unbounded wait.

username: str = (source)

Authentication user, empty when authentication is disabled.