FINAL suepr merge step : added all modules to this super repos
This commit is contained in:
101
sites/all/modules/contrib/mail/reroute_email/README.txt
Normal file
101
sites/all/modules/contrib/mail/reroute_email/README.txt
Normal file
@@ -0,0 +1,101 @@
|
||||
|
||||
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 -> Configuration -> Development -> Reroute email, and enter an
|
||||
email address to route all email to.
|
||||
|
||||
Tips and Tricks
|
||||
---------------
|
||||
Reroute Email provides configuration variables that you can directly override
|
||||
in the settings.php file of a site. This is useful for moving sites from live
|
||||
to test and vice versa.
|
||||
|
||||
To use this variable, you add the following line in the settings.php file
|
||||
for the test environment:
|
||||
|
||||
$conf['reroute_email_enable'] = 1;
|
||||
|
||||
And for the live site, you set it as follows:
|
||||
|
||||
$conf['reroute_email_enable'] = 0;
|
||||
|
||||
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.
|
||||
*/
|
||||
// Enable email rerouting.
|
||||
$conf['reroute_email_enable'] = 1;
|
||||
// Space, comma, or semicolon-delimited list of email addresses to pass
|
||||
// through. Every destination email address which is not on this list will be
|
||||
// rerouted to the first address on the list.
|
||||
$conf['reroute_email_address'] = "example@example.com";
|
||||
// Enable inserting a message into the email body when the mail is being
|
||||
// rerouted.
|
||||
$conf['reroute_email_enable_message'] = 1;
|
||||
|
||||
|
||||
Test Email Form
|
||||
---------------
|
||||
Reroute Email also provides a convenient form for testing email sending or
|
||||
rerouting. After enabling the module, a test email form is accessible under:
|
||||
Admin -> Configuration -> Development -> Reroute email -> Test email form
|
||||
|
||||
This form allows sending an email upon submission to the recipients entered in
|
||||
the fields To, Cc and Bcc, which is very practical for testing if emails are
|
||||
correctly rerouted to the configured addresses.
|
||||
|
||||
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)
|
||||
|
||||
Maintainers
|
||||
-----------
|
||||
rfay (http://drupal.org/user/30906)
|
||||
DYdave (http://drupal.org/user/467284)
|
||||
|
||||
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.
|
Reference in New Issue
Block a user