You are here

Home » API reference » Maillog / Mail Developer 8

README.txt in Maillog / Mail Developer 8

Same filename and directory in other branches
  1. 6 README.txt
  2. 7 README.txt
Maillog
-------
The Maillog module provides a method of keeping archival copies of all emails
sent through the site.


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 MailSystem module [1] 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 [1] to help
with this, and it may also help to hardcode the use of Maillog by adding these
lines to the end of the site's settings.php file:

// Use Maillog for delivery system emails.
$config['mailsystem.settings']['defaults']['sender'] = 'maillog';
$config['mailsystem.settings']['defaults']['formatter'] = 'maillog';


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


Credits / contact
--------------------------------------------------------------------------------
Maintained by Miro Dietiker [2], Sascha Grossenbacher [3] and Damien McKenna
[4]. Initial port to Drupal 8 by Antonio Sferlazza [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/mailsystem
2: https://www.drupal.org/u/miro_dietiker
3: https://www.drupal.org/u/berdir
4: https://www.drupal.org/u/damiemckenna
5: https://www.drupal.org/u/tonnosf

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.

  5. 

  6. 

  7. Features

  8. --------------------------------------------------------------------------------

  9. * All emails being sent by the site may have a copy stored in the database for

  10.   later review.

  11. 

  12. * All email delivery may be halted, preventing a site from sending out emails

  13.   in situations where that might not be needed, e.g. for a local development

  14.   copy of the site.

  15. 

  16. * If the MailSystem module [1] is installed it is possible to control which of

  17.   the installed email modules will be used to send messages from Maillog's

  18.   settings page, mirroring MailSystem's functionality.

  19. 

  20. 

  21. Configuration

  22. --------------------------------------------------------------------------------

  23.  1. On the People Permissions administration page ("Administer >> People

  24.     >> Permissions") there are three permissions to control:

  25. 

  26.     - The "Administer Maillog" permission allows users to access the settings

  27.       page to control the module's options.

  28. 

  29.     - The "View Maillog" permission allows users to access the Maillog list page

  30.       at admin/reports/maillog.

  31. 

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

  33.       from the log page.

  34. 

  35.  2. The main administrative page controls the module's settings page:

  36.       admin/config/development/maillog

  37. 

  38. 

  39. Troubleshooting / known issues

  40. --------------------------------------------------------------------------------

  41. If the email is not being logged then the site's default email system is not

  42. configured correctly. It is recommended to use the MailSystem module [1] to help

  43. with this, and it may also help to hardcode the use of Maillog by adding these

  44. lines to the end of the site's settings.php file:

  45. 

  46. // Use Maillog for delivery system emails.

  47. $config['mailsystem.settings']['defaults']['sender'] = 'maillog';

  48. $config['mailsystem.settings']['defaults']['formatter'] = 'maillog';

  49. 

  50. 

  51. Related modules

  52. --------------------------------------------------------------------------------

  53. Some similar modules that are available include:

  54. 

  55. * Reroute Email

  56.   Reroutes outbound emails to a specific destination address.

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

  58. 

  59. 

  60. Credits / contact

  61. --------------------------------------------------------------------------------

  62. Maintained by Miro Dietiker [2], Sascha Grossenbacher [3] and Damien McKenna

  63. [4]. Initial port to Drupal 8 by Antonio Sferlazza [5].

  64. 

  65. The best way to contact the authors is to submit an issue, be it a support

  66. request, a feature request or a bug report, in the project issue queue:

  67.   https://www.drupal.org/project/issues/maillog

  68. 

  69. 

  70. References

  71. --------------------------------------------------------------------------------

  72. 1: https://www.drupal.org/project/mailsystem

  73. 2: https://www.drupal.org/u/miro_dietiker

  74. 3: https://www.drupal.org/u/berdir

  75. 4: https://www.drupal.org/u/damiemckenna

  76. 5: https://www.drupal.org/u/tonnosf