You are here

Home » API reference » Reroute Email 5

README.txt in Reroute Email 5

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
  3. 7 README.txt
  4. 2.x README.txt
Copyright 2007 Khalid Baheyeldin and http://2bits.com

Description
-----------
This module intercepts all outgoing emails from a Drupal site and
reroutes them to a predefined configurable email address.

This is useful in case where you do not want email sent from a Drupal
site to reach the users. For example, if you copy a live site to a test
site for the purpose of development, and you do not want any email sent
to real users of the original site. Or you want to check the emails sent
for uniform formatting, footers, ...etc.

This is also a good demonstration of what hook_mail_alter(), available in
Drupal 5.x and later, can do.

Installation
------------
To install this module, do the following:

1. Extract the tar ball that you downloaded from Drupal.org.

2. Upload the entire directory and all its contents to your
   modules directory.

Configuration
-------------
To enable this module do the following:

1. Go to Admin -> Modules, and enable reroute email.

2. Go to Admin -> Settings -> Reroute email, and enter an email address
   to route all email to.

Tips and Tricks
---------------
Configuration and all the settings variables can be overridden in the
settings.php file by copying and pasting the code snippet below and changing
the values:

/**
 * Reroute Email module:
 *
 * To override specific variables and ensure that email rerouting is enabled or
 * disabled, change the values below accordingly for your site.
 */
// The email address to reroute all emails from the site to.
$conf['reroute_email_address'] = "example@example.com";


Bugs/Features/Patches:
----------------------
If you want to report bugs, feature requests, or submit a patch, please do so
at the project page on the Drupal web site.
http://drupal.org/project/reroute_email

Author
------
Khalid Baheyeldin (http://baheyeldin.com/khalid and http://2bits.com)

If you use this module, find it useful, and want to send the author
a thank you note, then use the Feedback/Contact page at the URL above.

The author can also be contacted for paid customizations of this
and other modules.

File

README.txt
View source 
  1. 

  2. Copyright 2007 Khalid Baheyeldin and http://2bits.com

  3. 

  4. Description

  5. -----------

  6. This module intercepts all outgoing emails from a Drupal site and

  7. reroutes them to a predefined configurable email address.

  8. 

  9. This is useful in case where you do not want email sent from a Drupal

  10. site to reach the users. For example, if you copy a live site to a test

  11. site for the purpose of development, and you do not want any email sent

  12. to real users of the original site. Or you want to check the emails sent

  13. for uniform formatting, footers, ...etc.

  14. 

  15. This is also a good demonstration of what hook_mail_alter(), available in

  16. Drupal 5.x and later, can do.

  17. 

  18. Installation

  19. ------------

  20. To install this module, do the following:

  21. 

  22. 1. Extract the tar ball that you downloaded from Drupal.org.

  23. 

  24. 2. Upload the entire directory and all its contents to your

  25.    modules directory.

  26. 

  27. Configuration

  28. -------------

  29. To enable this module do the following:

  30. 

  31. 1. Go to Admin -> Modules, and enable reroute email.

  32. 

  33. 2. Go to Admin -> Settings -> Reroute email, and enter an email address

  34.    to route all email to.

  35. 

  36. Tips and Tricks

  37. ---------------

  38. Configuration and all the settings variables can be overridden in the

  39. settings.php file by copying and pasting the code snippet below and changing

  40. the values:

  41. 

  42. /**

  43.  * Reroute Email module:

  44.  *

  45.  * To override specific variables and ensure that email rerouting is enabled or

  46.  * disabled, change the values below accordingly for your site.

  47.  */

  48. // The email address to reroute all emails from the site to.

  49. $conf['reroute_email_address'] = "example@example.com";

  50. 

  51. 

  52. Bugs/Features/Patches:

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

  54. If you want to report bugs, feature requests, or submit a patch, please do so

  55. at the project page on the Drupal web site.

  56. http://drupal.org/project/reroute_email

  57. 

  58. Author

  59. ------

  60. Khalid Baheyeldin (http://baheyeldin.com/khalid and http://2bits.com)

  61. 

  62. If you use this module, find it useful, and want to send the author

  63. a thank you note, then use the Feedback/Contact page at the URL above.

  64. 

  65. The author can also be contacted for paid customizations of this

  66. and other modules.