annotate mod_email_pass.wiki @ 433:56b79ff1c34c

Created wiki page through web user interface.
author luisgf@gmail.com
date Mon, 10 Mar 2014 08:17:39 +0000
parents
children 980b08cb4b1f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
433
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
1 #summary One-sentence summary of this page.
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
2 #labels Stage-Beta
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
3
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
4 = Introduction =
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
5
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
6 This module aims to help in the procedure of user password restoration. To start the restoration, the user must go to an URL provided by this module, fill the JID and email and submit the request.
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
7
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
8 The module will generate a token valid for 24h and send an email with a specially crafted url to the vCard email address. If the user goes to this url, will be able to change his password.
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
9
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
10 = Usage =
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
11 Simply add "offline_email" to your modules_enabled list.
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
12
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
13 This module only send emails to the vCard user email address, then the user must set this address in order to be capable of do the restoration.
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
14
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
15 = Configuration =
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
16
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
17 || smtp_server || The Host/ip of your SMTP server ||
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
18 || smtp_port || Port used by your SMTP server. Default 25 ||
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
19 || smtp_ssl || Use of SMTP SSL legacy (No STARTTLS) ||
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
20 || smtp_user || Username used to do SMTP auth ||
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
21 || smtp_pass || Password used to do SMTP auth ||
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
22 || smtp_address || EMail address that will be apears as From in mails ||
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
23 || msg_subject || Subject used for messages/mails ||
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
24 || msg_body || Message send when password has been changed ||
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
25 || url_path || Path where the module will be visible. Default /resetpass/ ||
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
26
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
27 = Compatibility =
56b79ff1c34c Created wiki page through web user interface.
luisgf@gmail.com
parents:
diff changeset
28 ||0.9||Works||