Packages
openmaize
2.1.2
3.0.1
retired
3.0.0
2.9.0
2.8.0
2.7.0
2.6.0
2.5.1
2.5.0
2.4.0
2.3.2
2.3.1
2.3.0
2.2.0
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.2
2.0.1
2.0.0
1.0.1
1.0.0
1.0.0-beta.5
1.0.0-beta.4
1.0.0-beta.3
1.0.0-beta.2
1.0.0-beta.1
1.0.0-beta.0
0.19.3
0.19.2
0.19.1
0.19.0
0.18.1
0.18.0
0.17.2
0.17.1
0.17.0
0.16.2
0.16.1
0.16.0
0.15.1
0.15.0
0.14.0
0.13.0
0.12.0
0.11.1
0.11.0
0.10.2
0.10.1
0.10.0
0.8.1
0.8.0
0.7.5
0.7.4
0.7.2
0.7.1
0.7.0
0.6.7
0.6.6
0.6.3
0.6.2
0.6.1
0.6.0
0.5.0
0.4.1
0.4.0
Authentication library for Elixir using Plug
Current section
68 Versions
Jump to
Current section
68 Versions
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 |