API Reference PhoenixKitInbox v#0.2.0

Copy Markdown View Source

Modules

Internal mailbox for PhoenixKit — an in-app email client for messages between the users of your application.

Central mapping from the error atoms this module's contexts return to translated, user-facing strings.

Mailbox lifecycle and access control.

Composing, sending, listing, and filing messages.

Versioned migration coordinator for phoenix_kit_inbox — the module returned from PhoenixKitInbox.migration_module/0.

V01 — the four Inbox tables.

Side effects that fire after a message is delivered — activity logging, in-app notifications, and the optional outbound email nudge.

Centralized URL paths for the Inbox module.

One mailbox's copy of a message — the row the mailbox UI actually lists.

A mailbox — the thing messages are delivered to.

Grants a user access to a mailbox they do not own.

The message body — stored once, regardless of how many mailboxes receive it. Per-recipient state (which folder it's in, whether it's been read, starred, trashed) lives on PhoenixKitInbox.Schemas.Delivery, one row per recipient mailbox.

Compose, reply, forward, and save drafts.

The mailbox — folder sidebar, message list, reading pane.

Shared mailbox management — create shared mailboxes and decide who can read, write, or administer each one.