PhoenixKit.Newsletters (PhoenixKitNewsletters v0.1.3)

Copy Markdown View Source

Newsletters module — email broadcasts and subscription management.

Provides newsletter list management, broadcast creation with Markdown editor, per-recipient delivery tracking via Oban workers, and unsubscribe flow.

Requires the Emails module to be enabled for full functionality. Template integration is optional — works without Emails installed.

Summary

Functions

count_active_members(list_uuid)

create_broadcast(attrs)

create_list(attrs)

delete_broadcast(broadcast)

delete_list(list)

find_delivery_by_message_id(message_id)

get_broadcast!(uuid)

get_broadcast_with_template!(uuid)

Returns a broadcast with optional template loaded.

If Emails module is available and the broadcast has a template_uuid, the template is loaded and put into broadcast.template. Otherwise broadcast.template is nil.

get_delivery_stats(broadcast_uuid)

get_list(uuid)

get_list!(uuid)

list_broadcasts(filters \\ %{})

list_deliveries(broadcast_uuid, filters \\ %{})

list_lists(filters \\ %{})

list_members(list_uuid, filters \\ %{})

list_user_subscriptions(user_uuid)

process_scheduled_broadcasts()

render_broadcast_html(broadcast)

subscribe_user(list_uuid, user_uuid)

unsubscribe_from_all(user_uuid)

unsubscribe_user(list_uuid, user_uuid)

update_broadcast(broadcast, attrs)

update_delivery_status(delivery, status, attrs \\ %{})

update_list(list, attrs)