orionis.mail.entities.Envelope

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.

Explore modules View classes

class documentation

class Envelope: (source)

Constructor: Envelope(subject, from_address, to, cc, ...)

View In Hierarchy

Store normalized immutable headers and intended recipients.

Parameters
subject	Literal subject, including an intentionally empty subject.
from_address	From header and transport sender.
to	Primary visible recipients.
cc	Additional visible recipients.
bcc	Hidden transport recipients.
reply_to	Reply destinations, which are never transport recipients.

Method	`__init__`	Normalize a declarative envelope without performing I/O.
Method	`recipients`	Return the stable deduplicated transport recipient union.
Class Variable	`bcc`	Undocumented
Class Variable	`cc`	Undocumented
Class Variable	`from_address`	Undocumented
Class Variable	`reply_to`	Undocumented
Class Variable	`subject`	Undocumented
Class Variable	`to`	Undocumented

def __init__(self, *, subject: str = '', from_address: str | Address | None = None, to: Recipients = (), cc: Recipients = (), bcc: Recipients = (), reply_to: Recipients = ()): (source) ¶

Normalize a declarative envelope without performing I/O.

Parameters
subject:`str`	Literal subject, including an empty subject.
from_address:`str \| Address \| None`	From header and transport sender.
to:`Recipients`	Primary visible recipients.
cc:`Recipients`	Additional visible recipients.
bcc:`Recipients`	Hidden transport recipients.
reply_to:`Recipients`	Reply destinations, not transport recipients.

Returns
`None`	Copy and validate all address collections.

Raises
`MailCompositionException`	If headers are invalid or a hidden recipient is also visible.

def recipients(self) -> tuple[str, ...]: (source) ¶

Return the stable deduplicated transport recipient union.

Returns
`tuple[str, ...]`	To, Cc, and Bcc addresses without Reply-To.

bcc: tuple[Address, ...] = (source) ¶

Undocumented

cc: tuple[Address, ...] = (source) ¶

Undocumented

from_address: Address | None = (source) ¶

Undocumented

reply_to: tuple[Address, ...] = (source) ¶

Undocumented

subject: str = (source) ¶

Undocumented

to: tuple[Address, ...] = (source) ¶

Undocumented