Openmaize v1.0.1 Openmaize.ConfirmEmail
Confirm a user’s email address.
Options
There are four options:
db_module - the module that is used to query the database
- in most cases, this will be generated by
mix openmaize.gen.ectodb
and will be called MyApp.OpenmaizeEcto - if you implement your own database module, it needs to implement the Openmaize.Database behaviour
- in most cases, this will be generated by
key_expires_after - the length, in minutes, that the token is valid for
- the default is 120 minutes (2 hours)
unique_id - the identifier in the query string, or the parameters
- the default is :email
- mail_function - the emailing function that you need to define
Examples
First, define a get "/confirm"
route in the web/router.ex file.
Then, add the following command to the relevant controller file:
plug Openmaize.ConfirmEmail, [db_module: MyApp.OpenmaizeEcto,
mail_function: &Mailer.send_receipt/1] when action in [:confirm]
This command will be run when the user accesses the confirm
route.
Summary
Functions
Generate a confirmation token and a link containing the email address and the token
Functions
Generate a confirmation token and a link containing the email address and the token.
The link is used to create the url that the user needs to follow to confirm the email address.
The user_id is the actual name or email address of the user, and
unique_id refers to the type of identifier. For example, if you
want to use username=fred
in your link, you need to set the
unique_id to :username. The default unique_id is :email.