You are here

README.txt in Webform Confirm Email Address 7.2

Same filename and directory in other branches
  1. 6.3 README.txt
  2. 6 README.txt
  3. 6.2 README.txt
  4. 7 README.txt
Purpose of this module
======================

webform_confirm_email is a simple addon module for the webform module.

If you define an email in webform (eg. mydomain.net/node/9999/webform/emails)
this email/these emails will be send immediately when the user clicked the
webform submit button.

This module allows you to let webform send a first email to the email address
the user specified in the webform asking him/her to click on a link (the second
webform email will not be send). When the user clicks the link from his/her
email the second webform email is send.

Using this module you can ensure that the email address the user entered is a
valid one.

Example 1: Letter writing campaign
==================================

The administrator creates a webform where a user can participate in a letter
campaign. The webform contains name and email fields for the user to enter.
Further, the administrator defines 2 emails, the first email will be send to
the email address the user provided in the webform, the 2nd will be send to the
letter writing email target.

When a user submits a webform, he/she receives a 1st email message containing a
link that should be followed to confirm the correctness of his/her email
address.

When the user uses the confirmation link, the 2nd email will be send to the
letterr writing email target.

Example 2: Online petition
==========================

The administrator creates a webform where a user can participate in an online
petition. The webform contains name and email fields for the user to enter.
Further, the administrator defines 2 emails, the first email will be send to
the email address the user provided in the webform, the 2nd will also be send
to the user with a short thank you for participating note.

When a user submits a webform, he/she receives a 1st email message containing a
link that should be followed to confirm the correctness of his/her email
address.

When the user uses the confirmation link, he/she will receive the 2n email with
the thank you note. Further his/her submission can be inserted into the list of
petition signers with valid email addresses.

Configuration
=============
You will only notice it is installed when visiting a webform emails
configuration tab. That is, if your webform is defined on a node with node ID
19, you'll find the settings by "http://mydomain.net/node/19/webform/emails".
With webform_confirm_email installed you'll see 3 email tables instead of 1,
one table for "standard emails", one for "confirmation request emails" and one
for "confirmation emails".

The "standard emails" behave just like normal webform emails, "confirmation
reques emails" are send to users asking them to click on a confirmation link
and "confirmation emails" are send only when the confirmation link was used.

The forms for changing the 3 different webform email settings (from address,
from name, to address, to name, ...) is the same as the webform email settings
form.  The only difference is in the 2nd email type, the "confirmation request
email", where you have an added entry in the "Token values" list, here you'll
find the [submission:confirm_url] token that should be used in confirmation
request emails.  This token will be expanded to the confirmation link. So as
an example the content of your "E-mail template" could look like this:

"Hello [submission:values:first_name] [submission:values:last_name],

Please visit the link below to confirm your submission:

 [submission:confirm_url]

Thank you!

Your petition team"

Installing
==========

Nothing special, if you're using drush that would be

drush dl webform_confirm_email

drush en webform_confirm_email -y

Updating
========
No updates are provided for all pre 7.x-1.0 versions.

From 7.x-1.0 onwards the will be a continues update path whith updates for
releases that change the database structure.

Todo/Plans
==========
* drupal 8 support

File

README.txt
View source
  1. Purpose of this module
  2. ======================
  3. webform_confirm_email is a simple addon module for the webform module.
  4. If you define an email in webform (eg. mydomain.net/node/9999/webform/emails)
  5. this email/these emails will be send immediately when the user clicked the
  6. webform submit button.
  7. This module allows you to let webform send a first email to the email address
  8. the user specified in the webform asking him/her to click on a link (the second
  9. webform email will not be send). When the user clicks the link from his/her
  10. email the second webform email is send.
  11. Using this module you can ensure that the email address the user entered is a
  12. valid one.
  13. Example 1: Letter writing campaign
  14. ==================================
  15. The administrator creates a webform where a user can participate in a letter
  16. campaign. The webform contains name and email fields for the user to enter.
  17. Further, the administrator defines 2 emails, the first email will be send to
  18. the email address the user provided in the webform, the 2nd will be send to the
  19. letter writing email target.
  20. When a user submits a webform, he/she receives a 1st email message containing a
  21. link that should be followed to confirm the correctness of his/her email
  22. address.
  23. When the user uses the confirmation link, the 2nd email will be send to the
  24. letterr writing email target.
  25. Example 2: Online petition
  26. ==========================
  27. The administrator creates a webform where a user can participate in an online
  28. petition. The webform contains name and email fields for the user to enter.
  29. Further, the administrator defines 2 emails, the first email will be send to
  30. the email address the user provided in the webform, the 2nd will also be send
  31. to the user with a short thank you for participating note.
  32. When a user submits a webform, he/she receives a 1st email message containing a
  33. link that should be followed to confirm the correctness of his/her email
  34. address.
  35. When the user uses the confirmation link, he/she will receive the 2n email with
  36. the thank you note. Further his/her submission can be inserted into the list of
  37. petition signers with valid email addresses.
  38. Configuration
  39. =============
  40. You will only notice it is installed when visiting a webform emails
  41. configuration tab. That is, if your webform is defined on a node with node ID
  42. 19, you'll find the settings by "http://mydomain.net/node/19/webform/emails".
  43. With webform_confirm_email installed you'll see 3 email tables instead of 1,
  44. one table for "standard emails", one for "confirmation request emails" and one
  45. for "confirmation emails".
  46. The "standard emails" behave just like normal webform emails, "confirmation
  47. reques emails" are send to users asking them to click on a confirmation link
  48. and "confirmation emails" are send only when the confirmation link was used.
  49. The forms for changing the 3 different webform email settings (from address,
  50. from name, to address, to name, ...) is the same as the webform email settings
  51. form. The only difference is in the 2nd email type, the "confirmation request
  52. email", where you have an added entry in the "Token values" list, here you'll
  53. find the [submission:confirm_url] token that should be used in confirmation
  54. request emails. This token will be expanded to the confirmation link. So as
  55. an example the content of your "E-mail template" could look like this:
  56. "Hello [submission:values:first_name] [submission:values:last_name],
  57. Please visit the link below to confirm your submission:
  58. [submission:confirm_url]
  59. Thank you!
  60. Your petition team"
  61. Installing
  62. ==========
  63. Nothing special, if you're using drush that would be
  64. drush dl webform_confirm_email
  65. drush en webform_confirm_email -y
  66. Updating
  67. ========
  68. No updates are provided for all pre 7.x-1.0 versions.
  69. From 7.x-1.0 onwards the will be a continues update path whith updates for
  70. releases that change the database structure.
  71. Todo/Plans
  72. ==========
  73. * drupal 8 support