Search documentation of phoenix_kit

# PhoenixKit.Users.Auth.UserNotifier (phoenix_kit v1.6.19)

View Source

User notification system for PhoenixKit authentication workflows.

This module handles email delivery for user authentication and account management workflows, including account confirmation, password reset, and email change notifications.

## Email Types

- Confirmation instructions: Sent during user registration
- Password reset instructions: Sent when user requests password reset
- Email update instructions: Sent when user changes their email address

## Configuration

Configure your mailer in your application config:

    config :phoenix_kit, PhoenixKit.Mailer,
      adapter: Swoosh.Adapters.SMTP,
      # ... other adapter configuration

## Customization

Override this module in your application to customize email templates and delivery behavior while maintaining the same function signatures.

# Summary

## Functions

deliver_confirmation_instructions(user, url)

Deliver instructions to confirm account.

deliver_magic_link_registration(user_or_email, url)

Deliver magic link registration instructions.

deliver_reset_password_instructions(user, url)

Deliver instructions to reset a user password.

deliver_update_email_instructions(user, url)

Deliver instructions to update a user email.

# Functions

# deliver_confirmation_instructions(user, url)

Deliver instructions to confirm account.

Uses the 'register' template from the database if available, falls back to hardcoded template if not found.

# deliver_magic_link_registration(user_or_email, url)

Deliver magic link registration instructions.

Uses the 'magic_link_registration' template from the database if available, falls back to hardcoded template if not found.

# deliver_reset_password_instructions(user, url)

Deliver instructions to reset a user password.

Uses the 'reset_password' template from the database if available, falls back to hardcoded template if not found.

# deliver_update_email_instructions(user, url)

Deliver instructions to update a user email.

Uses the 'update_email' template from the database if available, falls back to hardcoded template if not found.