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 entities components and public imports.

Module address Represent one mailbox with an optional Unicode display name.
Module attachment Describe a storage attachment without opening it or resolving a disk.
Module content Declare literal bodies or views with one explicit isolated context.
Module envelope Store normalized immutable headers and intended recipients.
Module options Snapshot the explicitly supplied options of one independent chain.
Module prepared Carry immutable MIME bytes and a separate validated transport envelope.
Module result Report SMTP acceptance or file storage, never final mailbox delivery.
Module smtp_settings Store effective SMTP settings without exposing credentials in repr.

From __init__.py:

Class Address Represent one mailbox with an optional Unicode display name.
Class Attachment Describe a storage attachment without opening it or resolving a disk.
Class Content Declare literal bodies or views with one explicit isolated context.
Class Envelope Store normalized immutable headers and intended recipients.
Class MailOptions Snapshot the explicitly supplied options of one independent chain.
Class MailResult Report SMTP acceptance or file storage, never final mailbox delivery.
Class PreparedMail Carry immutable MIME bytes and a separate validated transport envelope.
Class SmtpSettings Store effective SMTP settings without exposing credentials in repr.
Function __dir__ List loaded attributes and declared public exports.
Function __getattr__ Resolve and cache a public package export.
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.
_EXPORTS: dict = (source)

Public export names mapped to their defining modules and attributes.

Value
{'Address': ('orionis.mail.entities.address', 'Address'),
 'Attachment': ('orionis.mail.entities.attachment', 'Attachment'),
 'Content': ('orionis.mail.entities.content', 'Content'),
 'Envelope': ('orionis.mail.entities.envelope', 'Envelope'),
 'MailOptions': ('orionis.mail.entities.options', 'MailOptions'),
 'MailResult': ('orionis.mail.entities.result', 'MailResult'),
 'PreparedMail': ('orionis.mail.entities.prepared', 'PreparedMail'),
...