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 Mailable(ABC): (source)

View In Hierarchy

Declare reusable mail without I/O or per-send mutation.

Subclasses describe headers, bodies, and attachments synchronously. Pass an instance to Mail.send() when it is already constructed, or pass its class to let the application container inject constructor dependencies. Rendering, attachment reads, and transport happen afterwards, so the same instance can be sent concurrently without being modified.

Method attachments Declare deferred storage attachments synchronously.
Method content Declare literal bodies or views synchronously.
Method envelope Declare headers and recipients synchronously.
Class Variable __slots__ Undocumented
def attachments(self) -> Sequence[Attachment]: (source)

Declare deferred storage attachments synchronously.

Returns
Sequence[Attachment]Empty by default; subclasses may return their own declarations.
@abstractmethod
def content(self) -> Content: (source)

Declare literal bodies or views synchronously.

Returns
ContentContent whose rendering is deferred until sending.
@abstractmethod
def envelope(self) -> Envelope: (source)

Declare headers and recipients synchronously.

Returns
EnvelopeImmutable envelope, augmented by explicit PendingMail data.
__slots__: tuple = (source)

Undocumented