Loading README.txt→README.md +155 −0 Original line number Diff line number Diff line REROUTE EMAIL ------------- CONTENTS OF THIS FILE --------------------- * Description * Installation and configuration * Tips and Tricks * Settings code snippet * Test Email Form * Bugs / features / patches * Authors and maintainers * Link references -------------------------------------------------------------------------------- DESCRIPTION -------------------------------------------------------------------------------- This module intercepts all outgoing emails from a Drupal site and reroutes them # REROUTE EMAIL ## CONTENTS OF THIS FILE - Description - Installation and configuration - Tips and Tricks - Settings code snippet - Test Email Form - Bugs / features / patches - Authors and maintainers - Link references ## DESCRIPTION - This module intercepts all outgoing emails from a Drupal site and reroutes them to a list of predefined configurable email addresses. This is especially useful in cases where you would not want emails sent from a - This is especially useful in cases where you would not want emails sent from a Drupal site to reach target users. For example, if a live site was copied to a test site for development and testing purposes, in general, you would like to prevent any email sent from the test site to reach real users of the original site. The module is also an appropriate tool for checking closer outgoing emails for formatting, footers, headers, and more. Additionally, it is a good example of what hook_mail_alter(), available in - Additionally, it is a good example of what` hook_mail_alter()`, available in Drupal 5.x and later, can do. -------------------------------------------------------------------------------- INSTALLATION AND CONFIGURATION -------------------------------------------------------------------------------- ## INSTALLATION AND CONFIGURATION To install this module, do the following: 1 - Download the module and copy it into your contributed modules folder: [for example, your_drupal_path/sites/all/modules/contrib] and enable it from the 1. Download the module and copy it into your contributed modules folder: (for example, `your_drupal_path/sites/all/modules/contrib`) and enable it from the modules administration/management page (no requirements). More information at: Installing contributed modules (Drupal 8) [1]. More information at: Installing contributed modules (Drupal 8) (1). 2 - Configuration: 2. Configuration: After successful installation, browse to the Reroute Email settings page either by using the "Configure" link (next to module's name on the modules listing by using the "`Configure`" link (next to module's name on the modules listing page), or page's menu link under: Home » Administration » Configuration » Development Path: /admin/config/development/reroute_email `Home » Administration » Configuration » Development` `Path: /admin/config/development/reroute_email` 3 - Enter a list of email addresses to route all emails to. If the field is 3. Enter a list of email addresses to route all emails to. If the field is empty and no value is provided for rerouted email addresses, all outgoing emails would be aborted and recorded in the recent log entries, with a full dump of the email variables, which could provide an additional debugging method. The allowed list section allows setting up lists of email address and domain name exceptions for which outgoing emails would not be rerouted. -------------------------------------------------------------------------------- TIPS AND TRICKS -------------------------------------------------------------------------------- ## TIPS AND TRICKS 1 - Reroute Email provides configuration variables that can be directly 1. Reroute Email provides configuration variables that can be directly overridden in the settings.php file of a site. This is particularly useful for moving sites from live to test and vice versa. 2 - An example of setup would be to enable rerouting on a test environment, 2. An example of setup would be to enable rerouting on a test environment, while making sure it is disabled in production. ``` Add the following line in the settings.php file for the test environment: $config['reroute_email.settings']['enable'] = TRUE; $config['reroute_email.settings']['address'] = 'your.email@example.com'; And for the live site, set it as follows: $config['reroute_email.settings']['enable'] = FALSE; 3 - Your custom module can add a special header 'X-Rerouted-Force' with TRUE or FALSE value to any own emails in hook_mail or any emails in hook_mail_alter() ``` 3. Your custom module can add a special header '`X-Rerouted-Force`' with TRUE or FALSE value to any own emails in `hook_mail or any emails in hook_mail_alter()` implementations. This header will force enable or disable email rerouting by ignoring default settings. -------------------------------------------------------------------------------- SETTINGS.PHP CODE SNIPPET -------------------------------------------------------------------------------- ## SETTINGS.PHP CODE SNIPPET Configuration and all the settings variables can be overridden in the settings.php file by copying and pasting the code snippet below and changing - 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. */ - Reroute Email module: - To override specific variables and ensure that email rerouting is enabled or - disabled, change the values below accordingly for your site. **/ // Force enable/disable email rerouting. $config['reroute_email.settings']['enable'] = TRUE; Loading Loading @@ -132,43 +121,35 @@ $config['reroute_email.settings']['description'] = TRUE; // Force enable/disable inserting a message into the email body when the mail // is being rerouted. $config['reroute_email.settings']['message'] = TRUE; -------------------------------------------------------------------------------- TEST EMAIL FORM -------------------------------------------------------------------------------- ``` ## 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 Path: /admin/config/development/reroute_email/test `Admin » Configuration » Development » Reroute Email » Test email` form `Path: /admin/config/development/reroute_email/test` 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 -------------------------------------------------------------------------------- ## BUGS / FEATURES / PATCHES Feel free to follow up in the issue queue [2] for any contributions, bug - Feel free to follow up in the issue queue (2) for any contributions, bug reports, feature requests. Tests, feedback or comments in general are highly appreciated. - Tests, feedback or comments in general are highly appreciated. -------------------------------------------------------------------------------- AUTHORS AND MAINTAINERS -------------------------------------------------------------------------------- ## AUTHORS AND MAINTAINERS kbahey (https://www.drupal.org/user/4063) rfay (http://drupal.org/user/30906) DYdave (http://drupal.org/user/467284) bohart (https://drupal.org/user/289861) - kbahey - <https://www.drupal.org/user/4063> - rfay - <http://drupal.org/user/30906> - DYdave - <http://drupal.org/user/467284> - bohart - <https://drupal.org/user/289861> 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. -------------------------------------------------------------------------------- LINK REFERENCES -------------------------------------------------------------------------------- ## LINK REFERENCES 1: http://drupal.org/documentation/install/modules-themes/modules-8 2: https://www.drupal.org/project/issues/reroute_email 1. <http://drupal.org/documentation/install/modules-themes> 2. <https://www.drupal.org/project/issues/reroute_email> Loading
README.txt→README.md +155 −0 Original line number Diff line number Diff line REROUTE EMAIL ------------- CONTENTS OF THIS FILE --------------------- * Description * Installation and configuration * Tips and Tricks * Settings code snippet * Test Email Form * Bugs / features / patches * Authors and maintainers * Link references -------------------------------------------------------------------------------- DESCRIPTION -------------------------------------------------------------------------------- This module intercepts all outgoing emails from a Drupal site and reroutes them # REROUTE EMAIL ## CONTENTS OF THIS FILE - Description - Installation and configuration - Tips and Tricks - Settings code snippet - Test Email Form - Bugs / features / patches - Authors and maintainers - Link references ## DESCRIPTION - This module intercepts all outgoing emails from a Drupal site and reroutes them to a list of predefined configurable email addresses. This is especially useful in cases where you would not want emails sent from a - This is especially useful in cases where you would not want emails sent from a Drupal site to reach target users. For example, if a live site was copied to a test site for development and testing purposes, in general, you would like to prevent any email sent from the test site to reach real users of the original site. The module is also an appropriate tool for checking closer outgoing emails for formatting, footers, headers, and more. Additionally, it is a good example of what hook_mail_alter(), available in - Additionally, it is a good example of what` hook_mail_alter()`, available in Drupal 5.x and later, can do. -------------------------------------------------------------------------------- INSTALLATION AND CONFIGURATION -------------------------------------------------------------------------------- ## INSTALLATION AND CONFIGURATION To install this module, do the following: 1 - Download the module and copy it into your contributed modules folder: [for example, your_drupal_path/sites/all/modules/contrib] and enable it from the 1. Download the module and copy it into your contributed modules folder: (for example, `your_drupal_path/sites/all/modules/contrib`) and enable it from the modules administration/management page (no requirements). More information at: Installing contributed modules (Drupal 8) [1]. More information at: Installing contributed modules (Drupal 8) (1). 2 - Configuration: 2. Configuration: After successful installation, browse to the Reroute Email settings page either by using the "Configure" link (next to module's name on the modules listing by using the "`Configure`" link (next to module's name on the modules listing page), or page's menu link under: Home » Administration » Configuration » Development Path: /admin/config/development/reroute_email `Home » Administration » Configuration » Development` `Path: /admin/config/development/reroute_email` 3 - Enter a list of email addresses to route all emails to. If the field is 3. Enter a list of email addresses to route all emails to. If the field is empty and no value is provided for rerouted email addresses, all outgoing emails would be aborted and recorded in the recent log entries, with a full dump of the email variables, which could provide an additional debugging method. The allowed list section allows setting up lists of email address and domain name exceptions for which outgoing emails would not be rerouted. -------------------------------------------------------------------------------- TIPS AND TRICKS -------------------------------------------------------------------------------- ## TIPS AND TRICKS 1 - Reroute Email provides configuration variables that can be directly 1. Reroute Email provides configuration variables that can be directly overridden in the settings.php file of a site. This is particularly useful for moving sites from live to test and vice versa. 2 - An example of setup would be to enable rerouting on a test environment, 2. An example of setup would be to enable rerouting on a test environment, while making sure it is disabled in production. ``` Add the following line in the settings.php file for the test environment: $config['reroute_email.settings']['enable'] = TRUE; $config['reroute_email.settings']['address'] = 'your.email@example.com'; And for the live site, set it as follows: $config['reroute_email.settings']['enable'] = FALSE; 3 - Your custom module can add a special header 'X-Rerouted-Force' with TRUE or FALSE value to any own emails in hook_mail or any emails in hook_mail_alter() ``` 3. Your custom module can add a special header '`X-Rerouted-Force`' with TRUE or FALSE value to any own emails in `hook_mail or any emails in hook_mail_alter()` implementations. This header will force enable or disable email rerouting by ignoring default settings. -------------------------------------------------------------------------------- SETTINGS.PHP CODE SNIPPET -------------------------------------------------------------------------------- ## SETTINGS.PHP CODE SNIPPET Configuration and all the settings variables can be overridden in the settings.php file by copying and pasting the code snippet below and changing - 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. */ - Reroute Email module: - To override specific variables and ensure that email rerouting is enabled or - disabled, change the values below accordingly for your site. **/ // Force enable/disable email rerouting. $config['reroute_email.settings']['enable'] = TRUE; Loading Loading @@ -132,43 +121,35 @@ $config['reroute_email.settings']['description'] = TRUE; // Force enable/disable inserting a message into the email body when the mail // is being rerouted. $config['reroute_email.settings']['message'] = TRUE; -------------------------------------------------------------------------------- TEST EMAIL FORM -------------------------------------------------------------------------------- ``` ## 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 Path: /admin/config/development/reroute_email/test `Admin » Configuration » Development » Reroute Email » Test email` form `Path: /admin/config/development/reroute_email/test` 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 -------------------------------------------------------------------------------- ## BUGS / FEATURES / PATCHES Feel free to follow up in the issue queue [2] for any contributions, bug - Feel free to follow up in the issue queue (2) for any contributions, bug reports, feature requests. Tests, feedback or comments in general are highly appreciated. - Tests, feedback or comments in general are highly appreciated. -------------------------------------------------------------------------------- AUTHORS AND MAINTAINERS -------------------------------------------------------------------------------- ## AUTHORS AND MAINTAINERS kbahey (https://www.drupal.org/user/4063) rfay (http://drupal.org/user/30906) DYdave (http://drupal.org/user/467284) bohart (https://drupal.org/user/289861) - kbahey - <https://www.drupal.org/user/4063> - rfay - <http://drupal.org/user/30906> - DYdave - <http://drupal.org/user/467284> - bohart - <https://drupal.org/user/289861> 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. -------------------------------------------------------------------------------- LINK REFERENCES -------------------------------------------------------------------------------- ## LINK REFERENCES 1: http://drupal.org/documentation/install/modules-themes/modules-8 2: https://www.drupal.org/project/issues/reroute_email 1. <http://drupal.org/documentation/install/modules-themes> 2. <https://www.drupal.org/project/issues/reroute_email>
