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.
module documentation
Represent one mailbox with an optional Unicode display name.
| Function | addresses |
Normalize and stably deduplicate a recipient declaration. |
| Function | one |
Normalize exactly one mailbox and reject ambiguous names. |
| Constant | _HEADERS |
Headers used by address. |
| Type Alias | |
Accepted recipient declaration, re-exported by orionis.mail.types. |
Normalize and stably deduplicate a recipient declaration.
| Parameters | |
value:orionis.mail.types.Recipients | Single mailbox or a list/tuple of mailboxes. |
name:str | None | Optional name for a single string mailbox only. |
| Returns | |
tuple[orionis.mail.entities.Address, ...] | Mailboxes in first-declaration order. |
| Raises | |
orionis.mail.exceptions.MailCompositionException | If a collection is combined with a display name or has invalid entries. |
Normalize exactly one mailbox and reject ambiguous names.
| Parameters | |
value:str | orionis.mail.entities.Address | One mailbox. |
name:str | None | Display name, valid only with a string mailbox. |
| Returns | |
orionis.mail.entities.Address | Validated immutable address. |
| Raises | |
orionis.mail.exceptions.MailCompositionException | If the value is not one address or a name is supplied twice. |