Emulates that the email will change without actually changing it in the database.

examples

Examples

iex> apply_user_email(user, "valid password", %{email: ...})
{:ok, %User{}}

iex> apply_user_email(user, "invalid password", %{email: ...})
{:error, %Ecto.Changeset{}}

Returns an %Ecto.Changeset{} for changing the user email.

examples

Examples

iex> change_user_email(user)
%Ecto.Changeset{data: %User{}}

Returns an %Ecto.Changeset{} for changing the user password.

examples

Examples

iex> change_user_password(user)
%Ecto.Changeset{data: %User{}}

Returns an %Ecto.Changeset{} for tracking user changes.

examples

Examples

iex> change_user_registration(user)
%Ecto.Changeset{data: %User{}}

Confirms a user by the given token.

If the token matches, the user account is marked as confirmed and the token is deleted.

Deletes the signed token with the given context.

Delivers the confirmation email instructions to the given user.

examples

Examples

iex> deliver_user_confirmation_instructions(user, &url(~p"/admin/users/confirm/#{&1}"))
{:ok, %{to: ..., body: ...}}

iex> deliver_user_confirmation_instructions(confirmed_user, &url(~p"/admin/users/confirm/#{&1}"))
{:error, :already_confirmed}

Delivers the reset password email to the given user.

examples

Examples

iex> deliver_user_reset_password_instructions(user, &url(~p"/admin/users/reset_password/#{&1}"))
{:ok, %{to: ..., body: ...}}

Delivers the update email instructions to the given user.

examples

Examples

iex> deliver_user_update_email_instructions(user, current_email, &url(~p"/admin/users/settings/confirm_email/#{&1})")
{:ok, %{to: ..., body: ...}}

Generates a session token.

Gets a single user.

Returns nil if the User does not exist.

examples

Examples

iex> get_user(123)
%User{}

iex> get_user(456)
nil

Gets a single user.

Raises Ecto.NoResultsError if the User does not exist.

examples

Examples

iex> get_user!(123)
%User{}

iex> get_user!(456)
** (Ecto.NoResultsError)

Gets a user by email.

examples

Examples

iex> get_user_by_email("foo@example.com")
%User{}

iex> get_user_by_email("unknown@example.com")
nil

@spec get_user_by_email_and_password(String.t(), String.t()) ::
  Franklin.Accounts.User.t() | nil

Gets a user by email and password.

examples

Examples

iex> get_user_by_email_and_password("foo@example.com", "correct_password")
%User{}

iex> get_user_by_email_and_password("foo@example.com", "invalid_password")
nil

Gets the user by reset password token.

examples

Examples

iex> get_user_by_reset_password_token("validtoken")
%User{}

iex> get_user_by_reset_password_token("invalidtoken")
nil

Gets the user with the given signed token.

Registers a user.

examples

Examples

iex> register_user(%{field: value})
{:ok, %User{}}

iex> register_user(%{field: bad_value})
{:error, %Ecto.Changeset{}}

Resets the user password.

examples

Examples

iex> reset_user_password(user, %{password: "new long password", password_confirmation: "new long password"})
{:ok, %User{}}

iex> reset_user_password(user, %{password: "valid", password_confirmation: "not the same"})
{:error, %Ecto.Changeset{}}

Updates the user email using the given token.

If the token matches, the user email is updated and the token is deleted. The confirmed_at date is also updated to the current time.

Updates the user password.

examples

Examples

iex> update_user_password(user, "valid password", %{password: ...})
{:ok, %User{}}

iex> update_user_password(user, "invalid password", %{password: ...})
{:error, %Ecto.Changeset{}}