You are here

Home » API reference » Webform Confirm Email Address 6.3

README.txt in Webform Confirm Email Address 6.3

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

webform_confirm_email is a simple addon module for webform. 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 send a 1st email to the email address the user specified in the webform asking him/her to click on a link (the 2nd will not be send). If the user used the link a 2nd email is send. Using this method 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 %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:

"Hallo %value[first_name] %value[last_name],

  please visit the link below to confirm your 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-3.0 versions.

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

Todo/Plans
==========
* add configurable cron support for expiring (=deleting) old confirmation requests that haven't been confirmed
* provide hook for the event of expired/deleted confirmation requests
* change webform submission result table to filter for confirmed/not confirmed submissions
* add hook for "submission has been confirmed" events
* add rules event for "submission has been confirmed" events
* webform 4 support
* drupal 8 support

File

README.txt
View source 
  1. Purpose of this module

  2. ======================

  3. 

  4. webform_confirm_email is a simple addon module for webform. 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.

  5. This module allows you to send a 1st email to the email address the user specified in the webform asking him/her to click on a link (the 2nd will not be send). If the user used the link a 2nd email is send. Using this method you can ensure that the email address the user entered is a valid one.

  6. 

  7. Example 1: Letter writing campaign

  8. ==================================

  9. 

  10. 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.

  11. 

  12. 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.

  13. 

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

  15. 

  16. Example 2: Online petition

  17. ==========================

  18. 

  19. 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

  20. user provided in the webform, the 2nd will also be send to the user with a short thank you for participating note.

  21. 

  22. 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.

  23. 

  24. 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.

  25. 

  26. Configuration

  27. =============

  28. 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".

  29. 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". 

  30. 

  31. 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.

  32. 

  33. 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.

  34. 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 %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:

  35. 

  36. "Hallo %value[first_name] %value[last_name],

  37. 

  38.   please visit the link below to confirm your submission.

  39. 

  40. %confirm_url

  41. 

  42. Thank you!

  43. 

  44. Your petition team"

  45. 

  46. Installing

  47. ==========

  48. 

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

  50. 

  51. drush dl webform_confirm_email

  52. 

  53. drush en webform_confirm_email -y

  54. 

  55. Updating

  56. ========

  57. No updates are provided for all pre 7.x-3.0 versions.

  58. 

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

  60. 

  61. Todo/Plans

  62. ==========

  63. * add configurable cron support for expiring (=deleting) old confirmation requests that haven't been confirmed

  64. * provide hook for the event of expired/deleted confirmation requests

  65. * change webform submission result table to filter for confirmed/not confirmed submissions

  66. * add hook for "submission has been confirmed" events

  67. * add rules event for "submission has been confirmed" events

  68. * webform 4 support

  69. * drupal 8 support

  70.