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 Attachment: (source)
Describe a storage attachment without opening it or resolving a disk.
| Parameters | |
| path | Logical disk-relative path, normalized on declaration. |
| disk | Configured disk name, or None for the default disk. |
| name | Visible basename overriding the logical path's basename. |
| mime | Explicit MIME type overriding storage metadata and inference. |
| Class Method | from |
Declare a file to resolve through Orionis storage when sending. |
| Method | __post |
Validate logical paths and safe optional metadata without I/O. |
| Class Variable | disk |
Undocumented |
| Class Variable | mime |
Undocumented |
| Class Variable | name |
Undocumented |
| Class Variable | path |
Undocumented |
def fromStorage(cls, path:
str, *, disk: str | None = None, name: str | None = None, mime_type: str | None = None) -> Self:
(source)
¶
Declare a file to resolve through Orionis storage when sending.
| Parameters | |
path:str | Logical disk-relative path. |
disk:str | None | Configured disk name, or None for the default disk. |
name:str | None | Visible basename overriding the logical path's basename. |
mimestr | None | Explicit MIME type overriding storage metadata and inference. |
| Returns | |
Self | An immutable attachment declaration, with no I/O performed. |
| Raises | |
MailAttachmentException | If the declaration contains unsafe paths or metadata. |
Validate logical paths and safe optional metadata without I/O.
| Returns | |
None | Store canonical paths and MIME types. |
| Raises | |
MailAttachmentException | If a path, disk name, visible name, or MIME type is unsafe. |