You are here

Home » API reference » Newsletter 7

README.txt in Newsletter 7

Same filename and directory in other branches
  1. 7.2 README.txt
Newsletter
===============

The Newsletter module aims to be a full blown newsletter solution for Drupal 7.
It is recommended for people
that want more than one newsletter list for their site.
If you only need a single newsletter list then you would be better with
something else since this module would be an overkill.


Requirements
==============

--Libraries
--jQplot jQuery library (download it and extract to sites/all/libraries/jqplot)

There are no other requirements for this module's basic functionality.

You could install Colorbox though if you want a cool subscription experience
for your readers!

Finally for better user experience when editing templates,
you could install the wysiwyg module and choose one of the many supported
html editors!


Installation
=============

-Download and extract your module in your sites/all/modules/newsletter folder.

-Enable it through the administration area (admin/modules) or through drush
 (drush -y pm-enable newsletter).

-Navigate to admin/config/media/newsletter.


Usage
==========

You should create your templates by visiting the templates tab.
  Basic templates like subscribe/unsubscribe/welcome are created automatically
  but you can edit them to your needs.
  Also a default template is provided as an example.

After you create your templates, you have to create your lists.
  Visit the subscribers/list tab and click on create new list.

  ---Choosing your list to be exposed means that when a subscriber subscribes
     to this list he/she will be able to choose the terms he/she wishes to
     subscribe to.
  ---A list can have certain schedules (Daily, Weekly, Monthly, Custom) or
     none if you choose to be Manual.
  ---If you choose to be Custom then you will have to fill when this list should
     be sent.(eg when 1 node of the template-chosen terms is published)

Place the subscribe block to the region you like through the
admin/structure/block page.

Adjust the permissions in admin/people/permissions.

Thats it.People can now subscribe to your lists!
You can now sit down and enjoy the statistics to the statistics tab.
To send a manual newsletter (or to create a custom one)
visit the create/send tab.


Author/maintainer
===================

Original Author and Maintainer:

Paris Liakos (rootatwc)
http://drupal.org/user/1011436


Support
=======

Issues should be posted in the issue queue on drupal.org:

http://drupal.org/project/issues/newsletter

File

README.txt
View source 
  1. Newsletter

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

  3. 

  4. The Newsletter module aims to be a full blown newsletter solution for Drupal 7.

  5. It is recommended for people

  6. that want more than one newsletter list for their site.

  7. If you only need a single newsletter list then you would be better with

  8. something else since this module would be an overkill.

  9. 

  10. 

  11. Requirements

  12. ==============

  13. 

  14. --Libraries

  15. --jQplot jQuery library (download it and extract to sites/all/libraries/jqplot)

  16. 

  17. There are no other requirements for this module's basic functionality.

  18. 

  19. You could install Colorbox though if you want a cool subscription experience

  20. for your readers!

  21. 

  22. Finally for better user experience when editing templates,

  23. you could install the wysiwyg module and choose one of the many supported

  24. html editors!

  25. 

  26. 

  27. Installation

  28. =============

  29. 

  30. -Download and extract your module in your sites/all/modules/newsletter folder.

  31. 

  32. -Enable it through the administration area (admin/modules) or through drush

  33.  (drush -y pm-enable newsletter).

  34. 

  35. -Navigate to admin/config/media/newsletter.

  36. 

  37. 

  38. Usage

  39. ==========

  40. 

  41. You should create your templates by visiting the templates tab.

  42.   Basic templates like subscribe/unsubscribe/welcome are created automatically

  43.   but you can edit them to your needs.

  44.   Also a default template is provided as an example.

  45. 

  46. After you create your templates, you have to create your lists.

  47.   Visit the subscribers/list tab and click on create new list.

  48. 

  49.   ---Choosing your list to be exposed means that when a subscriber subscribes

  50.      to this list he/she will be able to choose the terms he/she wishes to

  51.      subscribe to.

  52.   ---A list can have certain schedules (Daily, Weekly, Monthly, Custom) or

  53.      none if you choose to be Manual.

  54.   ---If you choose to be Custom then you will have to fill when this list should

  55.      be sent.(eg when 1 node of the template-chosen terms is published)

  56. 

  57. Place the subscribe block to the region you like through the

  58. admin/structure/block page.

  59. 

  60. Adjust the permissions in admin/people/permissions.

  61. 

  62. Thats it.People can now subscribe to your lists!

  63. You can now sit down and enjoy the statistics to the statistics tab.

  64. To send a manual newsletter (or to create a custom one)

  65. visit the create/send tab.

  66. 

  67. 

  68. Author/maintainer

  69. ===================

  70. 

  71. Original Author and Maintainer:

  72. 

  73. Paris Liakos (rootatwc)

  74. http://drupal.org/user/1011436

  75. 

  76. 

  77. Support

  78. =======

  79. 

  80. Issues should be posted in the issue queue on drupal.org:

  81. 

  82. http://drupal.org/project/issues/newsletter