Current section

68 Versions

Jump to

Compare versions

3 files changed
+15 additions
-2 deletions
  @@ -69,4 +69,4 @@
69 69 {<<"name">>,<<"not_qwerty123">>},
70 70 {<<"optional">>,true},
71 71 {<<"requirement">>,<<"~> 1.2">>}]]}.
72 - {<<"version">>,<<"2.1.1">>}.
72 + {<<"version">>,<<"2.1.2">>}.
  @@ -1,7 +1,7 @@
1 1 defmodule Openmaize.Mixfile do
2 2 use Mix.Project
3 3
4 - @version "2.1.1"
4 + @version "2.1.2"
5 5
6 6 @description """
7 7 Authentication library for Elixir using Plug
  @@ -10,6 +10,10 @@ defmodule <%= base %>.Mailer do
10 10
11 11 @doc """
12 12 An email with a confirmation link in it.
13 +
14 + This function is called by the `create` function in the user_controller.
15 + It should send an email with the confirmation link to the user. The
16 + return value is not used.
13 17 """
14 18 def ask_confirm(_email, link) do
15 19 confirm_url = "http://www.example.com/sessions/confirm_email?#{link}"
  @@ -18,6 +22,10 @@ defmodule <%= base %>.Mailer do
18 22
19 23 @doc """
20 24 An email with a link to reset the password.
25 +
26 + This function is called by the `create` function in the password_reset_controller.
27 + It should send an email with the link to reset the password to the user. The
28 + return value is not used.
21 29 """
22 30 def ask_reset(_email, link) do
23 31 confirm_url = "http://www.example.com/password_resets/edit?#{link}"
  @@ -26,6 +34,11 @@ defmodule <%= base %>.Mailer do
26 34
27 35 @doc """
28 36 An email acknowledging that the account has been successfully confirmed.
37 +
38 + This function is called by the Openmaize.ConfirmEmail and the
39 + Openmaize.ResetPassword plugs. It should send an email stating that the
40 + account has been confirmed, or that the password has been reset, to the user.
41 + The return value is not used.
29 42 """
30 43 def receipt_confirm(email) do
31 44 email