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.

package documentation

Group the mail transports components and public imports.

Module file Publish complete private .eml files atomically without overwriting.
Module smtp Use one verified SMTP connection per message, entirely on a worker.

From __init__.py:

Class FileTransport Publish complete private .eml files atomically without overwriting.
Class SmtpTransport Use one verified SMTP connection per message, entirely on a worker.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
Function create_file_transport Build a file transport anchored to the application, never the process cwd.
Function create_smtp_transport Build SMTP from the central configuration without network activity.
Constant _EXPORTS Public export names mapped to their defining modules and attributes.
def __dir__() -> list[str]: (source)

List loaded attributes and declared public exports.

Returns
list[str]Sorted attribute names available on this package.
def __getattr__(name: str) -> object: (source)

Resolve and cache a public package export.

Parameters
name:strPublic attribute requested from this package.
Returns
objectExported object from its defining module.
Raises
AttributeErrorIf the requested attribute is not exported.
def create_file_transport(app: IApplication, config: Mapping[str, object]) -> IMailTransport: (source)

Build a file transport anchored to the application, never the process cwd.

Parameters
app:orionis.IApplicationContainer exposing the absolute application root.
config:collections.abc.Mapping[str, object]Normalized selected mailer configuration.
Returns
orionis.mail.contracts.IMailTransportA transport that creates no files until a message is sent.
Raises
orionis.mail.exceptions.MailConfigurationExceptionIf the configured output path is empty, invalid, or drive-relative.
def create_smtp_transport(app: IApplication, config: Mapping[str, object]) -> IMailTransport: (source)

Build SMTP from the central configuration without network activity.

Parameters
app:orionis.IApplicationContainer supplied uniformly to every transport factory.
config:collections.abc.Mapping[str, object]Normalized selected mailer settings.
Returns
orionis.mail.contracts.IMailTransportConfigured connection-per-message SMTP transport.
Raises
orionis.mail.exceptions.MailConfigurationExceptionIf the effective SMTP settings are invalid.
_EXPORTS: dict = (source)

Public export names mapped to their defining modules and attributes.

Value
{'FileTransport': ('orionis.mail.transports.file', 'FileTransport'),
 'SmtpTransport': ('orionis.mail.transports.smtp', 'SmtpTransport'),
 'create_file_transport': ('orionis.mail.transports.file',
                           'create_file_transport'),
 'create_smtp_transport': ('orionis.mail.transports.smtp',
                           'create_smtp_transport')}