You are here

Home » API reference » Webform Confirm Email Address 6.2

README.txt in Webform Confirm Email Address 6.2

Same filename and directory in other branches
  1. 6.3 README.txt
  2. 6 README.txt
  3. 7.2 README.txt
  4. 7 README.txt
=======
Read me
=======

:Author: Robin Millette <robin@millette.info>
:Date: 2010/03/27
:$Id$

Summary
=======
`Webform confirm email address`_ is used in combination with Webform_ as a `letter campaign`_ engine. Install and configure this module if you need to verify the email addresses your users provide before sending out letters. It prevents people from pretending they are someone else.

TODO
====
* Povide better feedback to the user.
* Use a template for the confirmation email.
* Cleanup unconfirmed webforms.

Requirements
============
I wrote it for Drupal 6. It depends on the Webform_ 6.x-2.x module.

Installation
============
Install as usual, see http://drupal.org/node/70151 for further information.

Configuration
=============
First, set up up a Webform as explained in `letter campaign`_ or using your own method. Next, find the email component of that form you want to use as the sender's email. In **Advanced settings**, check **Must confirm this email address**. You are done.

Customization
=============
Nothing I can think of for now. Maybe I'll implement a template for the confirmation email if there is demand.

Troubleshooting
===============
See the `support issues`_ on the Drupal website.

FAQ
===
How does it work?
  Quite frankly, I'm not really sure :) But seriously, the module intercepts the letter before it is sent with a *hook_mail_alter* and sends its own confirmation mail instead to the person listed as the source. That email contains a cryptographically signed link the user must follow to confirm his identity. Once the website gets that, the letter we intercepted gets sent.

Why isn't this in Webform?
  Dunno. I never asked the Webform_ maintainers if they were interested. Maybe it'll make its way there and this more will become obselete.

What was this tested with?
  Drupal 6.16 and Webform 6.x-2.9. Let me know if you try it with other versions.

Contact
=======
Current maintainer
------------------
Robin Millette (millette) - http://drupal.org/user/49105

Sponsor
-------
This module provided to you by la Ligue des Contribuables (du Québec) and Muniduweb.

Colophon
========
This document is written using the ReStructuredText markup. Go get Docutils_ if you'd like to see this document in a format such as HTML, LaTeX or PDF. You may also convert this file using my `Text filter web service`.

.. _Webform: http://drupal.org/project/webform
.. _`Webform confirm email address`: http://drupal.org/project/webform_confirm_email
.. _Docutils: http://docutils.sourceforge.net/
.. _`Text filter web service`: http://textfilters.appspot.com/
.. _`letter campaign`: http://dharmatech.org/blog/creating_letter_editor_form_drupal/06/11/09
.. _`support issues`: http://drupal.org/project/issues/webform_confirm_email?categories=support

File

README.txt
View source 
  1. =======

  2. Read me

  3. =======

  4. 

  5. :Author: Robin Millette 

  6. :Date: 2010/03/27

  7. :$Id$

  8. 

  9. Summary

  10. =======

  11. `Webform confirm email address`_ is used in combination with Webform_ as a `letter campaign`_ engine. Install and configure this module if you need to verify the email addresses your users provide before sending out letters. It prevents people from pretending they are someone else.

  12. 

  13. TODO

  14. ====

  15. * Povide better feedback to the user.

  16. * Use a template for the confirmation email.

  17. * Cleanup unconfirmed webforms.

  18. 

  19. Requirements

  20. ============

  21. I wrote it for Drupal 6. It depends on the Webform_ 6.x-2.x module.

  22. 

  23. Installation

  24. ============

  25. Install as usual, see http://drupal.org/node/70151 for further information.

  26. 

  27. Configuration

  28. =============

  29. First, set up up a Webform as explained in `letter campaign`_ or using your own method. Next, find the email component of that form you want to use as the sender's email. In **Advanced settings**, check **Must confirm this email address**. You are done.

  30. 

  31. Customization

  32. =============

  33. Nothing I can think of for now. Maybe I'll implement a template for the confirmation email if there is demand.

  34. 

  35. Troubleshooting

  36. ===============

  37. See the `support issues`_ on the Drupal website.

  38. 

  39. FAQ

  40. ===

  41. How does it work?

  42.   Quite frankly, I'm not really sure :) But seriously, the module intercepts the letter before it is sent with a *hook_mail_alter* and sends its own confirmation mail instead to the person listed as the source. That email contains a cryptographically signed link the user must follow to confirm his identity. Once the website gets that, the letter we intercepted gets sent.

  43. 

  44. Why isn't this in Webform?

  45.   Dunno. I never asked the Webform_ maintainers if they were interested. Maybe it'll make its way there and this more will become obselete.

  46. 

  47. What was this tested with?

  48.   Drupal 6.16 and Webform 6.x-2.9. Let me know if you try it with other versions.

  49. 

  50. Contact

  51. =======

  52. Current maintainer

  53. ------------------

  54. Robin Millette (millette) - http://drupal.org/user/49105

  55. 

  56. Sponsor

  57. -------

  58. This module provided to you by la Ligue des Contribuables (du Québec) and Muniduweb.

  59. 

  60. Colophon

  61. ========

  62. This document is written using the ReStructuredText markup. Go get Docutils_ if you'd like to see this document in a format such as HTML, LaTeX or PDF. You may also convert this file using my `Text filter web service`.

  63. 

  64. .. _Webform: http://drupal.org/project/webform

  65. .. _`Webform confirm email address`: http://drupal.org/project/webform_confirm_email

  66. .. _Docutils: http://docutils.sourceforge.net/

  67. .. _`Text filter web service`: http://textfilters.appspot.com/

  68. .. _`letter campaign`: http://dharmatech.org/blog/creating_letter_editor_form_drupal/06/11/09

  69. .. _`support issues`: http://drupal.org/project/issues/webform_confirm_email?categories=support

  70. 

  71.