You are here

Home » API reference » Mailing List 8

README.txt in Mailing List 8 

MAILING LIST DRUPAL MODULE
==========================

CONTENTS OF THIS FILE
---------------------

 * Summary
 * Requirements
 * Installation
 * Configuration
 * Recommended modules
 * Contact


SUMMARY
-------

This is a multipurpose mailing list module. It provides:

 * a mailing list entity type. Create a bundle for each particular list your
   website needs. Define your own fields that will be available on the
   subscription form.

 * a subscription entity type. Subscriptions are content entities, they will
   be available for views, hooks, etc.

 * double opt-in with email confirmation


REQUIREMENTS
------------

No special requirements needed for single opt-in mailing list. The
subscription confirmation depends on the email_confirmer module available at:

https://www.drupal.org/project/email_confirmer


INSTALLATION
------------

Install the main mailing list module as usual, see:

  https://www.drupal.org/node/1897420

for further information.

The confirmed opt-in is provided by the mailing list confirm submodule. Enable
it and its dependencies if they were not installed.


CONFIGURATION
-------------

Basic steps:

 * create your first mailing list at Structure -> Mailing lists -> Add a new
   mailing list

 * grant the subscribe permission to some roles at People -> Permissions. Also
   enable access email confirmation (provided by email_confirmer) if
   subscription confirmation is enabled

 * add a subscription block in some area at Structure -> Block layout -> Place
   block

 * administer subscriptions at People -> Mailing list subscriptions


RECOMMENDED MODULES
-------------------

 * Views Send (views_send) - https://www.drupal.org/project/views_send
   Send newsletters to your mailing list subscribers with it.

 * Automatic Entity Label (auto_entitylabel) -
   https://www.drupal.org/project/auto_entitylabel
   Hide subscription title/name and fill it with a computed value.

 * CSV Serialization - (csv_serialization) -
   https://www.drupal.org/project/csv_serialization
   To export your mailing list as CSV.

 * Inmail (inmail) - https://www.drupal.org/project/inmail
   Deal with bounces.


CONTACT
-------

Current maintainers:

Drupal 8 version:

 * Manuel Adan (manuel.adan) - https://www.drupal.org/user/516420

Drupal 7 version:

 * Oleg Terenchuk (litwol) - https://www.drupal.org/user/78134
 * Jacob Singh (JacobSingh) - https://www.drupal.org/user/68912

File

README.txt
View source 
  1. MAILING LIST DRUPAL MODULE

  2. ==========================

  3. 

  4. CONTENTS OF THIS FILE

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

  6. 

  7.  * Summary

  8.  * Requirements

  9.  * Installation

  10.  * Configuration

  11.  * Recommended modules

  12.  * Contact

  13. 

  14. 

  15. SUMMARY

  16. -------

  17. 

  18. This is a multipurpose mailing list module. It provides:

  19. 

  20.  * a mailing list entity type. Create a bundle for each particular list your

  21.    website needs. Define your own fields that will be available on the

  22.    subscription form.

  23. 

  24.  * a subscription entity type. Subscriptions are content entities, they will

  25.    be available for views, hooks, etc.

  26. 

  27.  * double opt-in with email confirmation

  28. 

  29. 

  30. REQUIREMENTS

  31. ------------

  32. 

  33. No special requirements needed for single opt-in mailing list. The

  34. subscription confirmation depends on the email_confirmer module available at:

  35. 

  36. https://www.drupal.org/project/email_confirmer

  37. 

  38. 

  39. INSTALLATION

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

  41. 

  42. Install the main mailing list module as usual, see:

  43. 

  44.   https://www.drupal.org/node/1897420

  45. 

  46. for further information.

  47. 

  48. The confirmed opt-in is provided by the mailing list confirm submodule. Enable

  49. it and its dependencies if they were not installed.

  50. 

  51. 

  52. CONFIGURATION

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

  54. 

  55. Basic steps:

  56. 

  57.  * create your first mailing list at Structure -> Mailing lists -> Add a new

  58.    mailing list

  59. 

  60.  * grant the subscribe permission to some roles at People -> Permissions. Also

  61.    enable access email confirmation (provided by email_confirmer) if

  62.    subscription confirmation is enabled

  63. 

  64.  * add a subscription block in some area at Structure -> Block layout -> Place

  65.    block

  66. 

  67.  * administer subscriptions at People -> Mailing list subscriptions

  68. 

  69. 

  70. RECOMMENDED MODULES

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

  72. 

  73.  * Views Send (views_send) - https://www.drupal.org/project/views_send

  74.    Send newsletters to your mailing list subscribers with it.

  75. 

  76.  * Automatic Entity Label (auto_entitylabel) -

  77.    https://www.drupal.org/project/auto_entitylabel

  78.    Hide subscription title/name and fill it with a computed value.

  79. 

  80.  * CSV Serialization - (csv_serialization) -

  81.    https://www.drupal.org/project/csv_serialization

  82.    To export your mailing list as CSV.

  83. 

  84.  * Inmail (inmail) - https://www.drupal.org/project/inmail

  85.    Deal with bounces.

  86. 

  87. 

  88. CONTACT

  89. -------

  90. 

  91. Current maintainers:

  92. 

  93. Drupal 8 version:

  94. 

  95.  * Manuel Adan (manuel.adan) - https://www.drupal.org/user/516420

  96. 

  97. Drupal 7 version:

  98. 

  99.  * Oleg Terenchuk (litwol) - https://www.drupal.org/user/78134

  100.  * Jacob Singh (JacobSingh) - https://www.drupal.org/user/68912