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

View In Hierarchy

Snapshot the explicitly supplied options of one independent chain.

Method envelope Overlay explicit scalars and append recipients to a declaration.
Instance Variable attachments Deferred attachments appended to a declaration.
Instance Variable bcc Hidden recipients appended to a declaration.
Instance Variable cc Carbon-copy recipients appended to a declaration.
Instance Variable from_address Explicit sender replacing any declared one.
Instance Variable mailer Selected configuration name, or None for the central default.
Instance Variable reply_to Reply destinations appended to a declaration.
Instance Variable subject Explicit subject replacing any declared one.
Instance Variable to Visible recipients appended to a declaration.
def envelope(self, base: Envelope | None = None) -> Envelope: (source)

Overlay explicit scalars and append recipients to a declaration.

Parameters
base:orionis.mail.entities.Envelope | NoneOptional reusable Mailable envelope.
Returns
orionis.mail.entities.EnvelopeValidated envelope owned by the operation.
Raises
orionis.mail.exceptions.MailCompositionExceptionIf the merged recipients violate Bcc privacy.

Deferred attachments appended to a declaration.

Hidden recipients appended to a declaration.

Carbon-copy recipients appended to a declaration.

from_address: orionis.mail.entities.Address | None = (source)

Explicit sender replacing any declared one.

mailer: str | None = (source)

Selected configuration name, or None for the central default.

Reply destinations appended to a declaration.

subject: str | None = (source)

Explicit subject replacing any declared one.

Visible recipients appended to a declaration.