Specs

confirm(
  module :: module(),
  config :: Haytni.ConfirmablePlugin.Config.t(),
  token :: String.t()
) :: {:ok, Haytni.user()} | {:error, String.t()}

Confirms an account from its confirmation token.

Returns {:error, reason} if token is expired or invalid else the (updated) user as {:ok, user}.

Specs

confirm_user(module :: module(), user :: Haytni.user()) ::
  Haytni.repo_nobang_operation(Haytni.user())

Allows a privilegied user (administrator) to manually confirm a user.

Example: you could add a route in your administration panel:

scope "/admin" do
  pipe_through ~W[browser restricted_to_admin]a

  resources "/users" do
    resources "/confirm", YourAppWeb.Admin.User.ConfirmController, singleton: true, only: ~W[update]a
  end
end

With the above controller calling this function:

defmodule YourAppWeb.Admin.User.ConfirmController do
  def update(conn, %{"user_id" => user_id}) do
    user = YourApp.UserContext.get_user!(user_id)
    {:ok, user} = Haytni.ConfirmablePlugin.confirm_user(YourAppWeb.Haytni, user)

    conn
    |> put_flash(:info, "user has been confirmed")
    |> redirect(to: Routes.admin_user_path(conn, :index))
    |> halt()
  end
end

And do the link in your templates with:

Status: <%= if Haytni.ConfirmablePlugin.confirmed?(user) do %>
  Confirmed
<% else %>
  Not confirmed (<%= link "force confirmation?", to: Routes.admin_user_confirm_path(@conn, user, :update) %>)
<% end %>

Specs

confirmation_request_changeset(
  config :: Haytni.ConfirmablePlugin.Config.t(),
  confirmation_params :: Haytni.params()
) :: Ecto.Changeset.t()

This function converts the parameters received by the controller to request a new confirmation token sent by email to an %Ecto.Changeset{}, a convenient way to perform basic validations, any intermediate handling and casting.

Specs

confirmed?(user :: Haytni.user()) :: boolean()

Has the given user been confirmed?

Specs

confirmed_attributes() :: Keyword.t()

The (database) attribute(s) as a keyword-list (field name: new value) to update a user as a confirmed account

Callback implementation for Haytni.Plugin.find_user/3.

Specs

invalid_token_message() :: String.t()

The translated string to display when (re)confirmation token is invalid (meaning matches no one)

Callback implementation for Haytni.Plugin.on_delete_user/4.

Callback implementation for Haytni.Plugin.on_failed_authentication/5.

Callback implementation for Haytni.Plugin.on_logout/3.

Callback implementation for Haytni.Plugin.on_successful_authentication/6.

Specs

pending_confirmation_message() :: String.t()

The translated string to display when account is on pending (re)confirmation.

Specs

reconfirm(
  module :: module(),
  config :: Haytni.ConfirmablePlugin.Config.t(),
  user :: Haytni.user(),
  token :: String.t()
) :: {:ok, Haytni.user()} | {:error, String.t()}

Reconfirms (validates an email address after its change) an account from its confirmation token.

Returns {:error, reason} if token is expired or invalid else the (updated) user as {:ok, user}.

Specs

resend_confirmation_instructions(
  module :: module(),
  config :: Haytni.ConfirmablePlugin.Config.t(),
  confirmation_params :: Haytni.params()
) :: {:ok, Haytni.nilable(Haytni.Token.t())} | {:error, Ecto.Changeset.t()}

Resend confirmation instructions to an email address (requested by its owner).

Returns:

• {:ok, token}: a token was actualy sent by mail
• {:ok, nil}: there is no account matching config.confirmation_keys or the account is not pending confirmation
• {:error, changeset}: fields (form) was invalid

Callback implementation for Haytni.Plugin.validate_create_registration/3.

Callback implementation for Haytni.Plugin.validate_password/3.

Callback implementation for Haytni.Plugin.validate_update_registration/3.