You are here

README.txt in Maillog / Mail Developer 7

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
Maillog
-------
The Maillog module provides a method of keeping archival copies of all emails
sent through the site. It can also, optionally, display a copy of the email
using the Devel module [1], if present.


Features
--------------------------------------------------------------------------------
* All emails being sent by the site may have a copy stored in the database for
  later review.

* All email delivery may be halted, preventing a site from sending out emails
  in situations where that might not be needed, e.g. for a local development
  copy of the site.

* If the Devel module is installed [1], emails can also be displayed on the page
  as they are being sent.

* If the MailSystem module [2] is installed it is possible to control which of
  the installed email modules will be used to send messages from Maillog's
  settings page, mirroring MailSystem's functionality.


Configuration
--------------------------------------------------------------------------------
 1. On the People Permissions administration page ("Administer >> People
    >> Permissions") there are three permissions to control:

    - The "Administer Maillog" permission allows users to access the settings
      page to control the module's options.

    - The "View Maillog" permission allows users to access the Maillog list page
      at admin/reports/maillog.

    - The "Delete Entries from the log" permission allows users to delete items
      from the log page.

 2. The main administrative page controls the module's settings page:
      admin/config/development/maillog


Troubleshooting / known issues
--------------------------------------------------------------------------------
If the email is not being logged then the site's default email system is not
configured correctly. It is recommended to use the MailSystem module [2] to help
with this. Alternatively, add the following to the enf of the site's
settings.php file:

// Control which module is responsible for sending the site's emails.
$conf['mail_system'] = array(
  'default-system' => 'MaillogMailSystem',
);


Related modules
--------------------------------------------------------------------------------
Some similar modules that are available include:

* Reroute Email
  Reroutes outbound emails to a specific destination address.
  http://drupal.org/project/reroute_email

* Advanced Mail Reroute
  Reroutes outbound emails with complete control over the destination based upon
  the email's key.
  http://drupal.org/project/advanced_mail_reroute

* Mail Logger
  Logs all emails sent through the site.
  http://drupal.org/project/mail_logger


Credits / contact
--------------------------------------------------------------------------------
Maintained by Miro Dietiker [3], Sascha Grossenbacher [4] and Damien McKenna
[5].

The best way to contact the authors is to submit an issue, be it a support
request, a feature request or a bug report, in the project issue queue:
  https://www.drupal.org/project/issues/maillog


References
--------------------------------------------------------------------------------
1: https://www.drupal.org/project/devel
2: https://www.drupal.org/project/mailsystem
3: https://www.drupal.org/u/miro_dietiker
4: https://www.drupal.org/u/berdir
5: https://www.drupal.org/u/damiemckenna

File

README.txt
View source
  1. Maillog
  2. -------
  3. The Maillog module provides a method of keeping archival copies of all emails
  4. sent through the site. It can also, optionally, display a copy of the email
  5. using the Devel module [1], if present.
  6. Features
  7. --------------------------------------------------------------------------------
  8. * All emails being sent by the site may have a copy stored in the database for
  9. later review.
  10. * All email delivery may be halted, preventing a site from sending out emails
  11. in situations where that might not be needed, e.g. for a local development
  12. copy of the site.
  13. * If the Devel module is installed [1], emails can also be displayed on the page
  14. as they are being sent.
  15. * If the MailSystem module [2] is installed it is possible to control which of
  16. the installed email modules will be used to send messages from Maillog's
  17. settings page, mirroring MailSystem's functionality.
  18. Configuration
  19. --------------------------------------------------------------------------------
  20. 1. On the People Permissions administration page ("Administer >> People
  21. >> Permissions") there are three permissions to control:
  22. - The "Administer Maillog" permission allows users to access the settings
  23. page to control the module's options.
  24. - The "View Maillog" permission allows users to access the Maillog list page
  25. at admin/reports/maillog.
  26. - The "Delete Entries from the log" permission allows users to delete items
  27. from the log page.
  28. 2. The main administrative page controls the module's settings page:
  29. admin/config/development/maillog
  30. Troubleshooting / known issues
  31. --------------------------------------------------------------------------------
  32. If the email is not being logged then the site's default email system is not
  33. configured correctly. It is recommended to use the MailSystem module [2] to help
  34. with this. Alternatively, add the following to the enf of the site's
  35. settings.php file:
  36. // Control which module is responsible for sending the site's emails.
  37. $conf['mail_system'] = array(
  38. 'default-system' => 'MaillogMailSystem',
  39. );
  40. Related modules
  41. --------------------------------------------------------------------------------
  42. Some similar modules that are available include:
  43. * Reroute Email
  44. Reroutes outbound emails to a specific destination address.
  45. http://drupal.org/project/reroute_email
  46. * Advanced Mail Reroute
  47. Reroutes outbound emails with complete control over the destination based upon
  48. the email's key.
  49. http://drupal.org/project/advanced_mail_reroute
  50. * Mail Logger
  51. Logs all emails sent through the site.
  52. http://drupal.org/project/mail_logger
  53. Credits / contact
  54. --------------------------------------------------------------------------------
  55. Maintained by Miro Dietiker [3], Sascha Grossenbacher [4] and Damien McKenna
  56. [5].
  57. The best way to contact the authors is to submit an issue, be it a support
  58. request, a feature request or a bug report, in the project issue queue:
  59. https://www.drupal.org/project/issues/maillog
  60. References
  61. --------------------------------------------------------------------------------
  62. 1: https://www.drupal.org/project/devel
  63. 2: https://www.drupal.org/project/mailsystem
  64. 3: https://www.drupal.org/u/miro_dietiker
  65. 4: https://www.drupal.org/u/berdir
  66. 5: https://www.drupal.org/u/damiemckenna