You are here

Home » API reference » Notify 2.0.x

README.txt in Notify 2.0.x

Same filename and directory in other branches
  1. 8 README.txt
  2. 5.2 README.txt
  3. 5 README.txt
  4. 6 README.txt
  5. 7 README.txt
  6. 1.0.x README.txt
NOTIFY README.txt
=================


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

* Introduction
* Requirements
* Installation
* Configuration
* Per user settings
* Related projects & alternatives
* Maintainers


INTRODUCTION
------------

Notify is a simple, lightweight module for sending plain text e-mail
notifications about new content and comments posted on a Drupal web
site.

* For a full description of the module, visit the project page:
  https://drupal.org/project/notify

* For more documentation about its use, visit the documentation page:
  https://www.drupal.org/documentation/modules/notify

* To submit bug reports and feature suggestions, or to track changes:
  https://drupal.org/project/issues/notify

If you enable node revisions (https://www.drupal.org/node/320614), the
notification e-mail will also mention the name of the last person to
edit the node.


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

This module requires a supported version of Drupal and cron to be
running at least as frequently as you want to send out notifications.


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

1. Install Notify as you would normally install a contributed Drupal
   module.

2. Enable Notify module by locating it on the list under the Extend
   tab in the administrative GUI. The tables will be created
   automagically for you at this point.

3. Modify permissions on the People » Permissions page.

   To set the notification checkbox default on new user registration
   form, or let new users opt in for notifications during
   registration, you must grant the anonymous user the right to access
   Notify.

4. Configure general notification settings.  See the "Configuration"
   section below for details.


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

The administrative interface is at: Administration » Configuration »
People » Notify settings.

- The "Settings" tab is for setting how often notifications are sent.

- The and "Default settings" tab is to set up default presets for new
  users, and for selecting permitted notification by node type.

- The "Users" tab is to review and see per-user settings.

- The remaining to tabs ("Queue" and "Skip flags") are for managing
  the notification queue.

When setting how often notifications are sent, note that e-mail
updates can only happen as frequently as the cron is set to run.
Check your cron settings.


PER USER SETTINGS
-----------------

To manage your own notification preferences, click on the
"Notification settings" on your "My account" page.


RELATED PROJECTS & ALTERNATIVES
-------------------------------

The Mailchimp project (https://www.drupal.org/project/mailchimp)
provides integration with external Mailchimp email delivery
service. It can be set up to produce a formatted HTML newsletter based
upon the site's RSS-feed.

Also see the section "Similar Modules" on the project page for links
to paged listing other newsletter and email notification modules.


MAINTAINERS
-----------

Kjartan Mannes <kjartan@drop.org> is the original author.
Rob Barreca <rob@electronicinsight.com> was a previous maintainer.
Matt Chapman <matt@ninjitsuweb.com> is the project owner.
Gisle Hannemyr <gisle@hannemyr.no> maintains the Drupal 7 branch.

Marton Bodonyi (http://www.interactivejunky.com/),
Mark Lindsey,
John Oltman <john.oltman@sitebasin.com>,
Ward Poelmans <wpoely86@gmail.com>,
Ishmael Sanchez (http://ishmaelsanchez.com), and
Ajit Shinde (https://www.facebook.com/shinde.ajit)
contributed to the Drupal 7 port.
Vincent Rommelaars <vincent@hostplek.nl> contributed to the Drupal 8
port.

File

README.txt
View source 
  1. NOTIFY README.txt

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

  3. 

  4. 

  5. CONTENTS OF THIS FILE

  6. ---------------------

  7. 

  8. * Introduction

  9. * Requirements

  10. * Installation

  11. * Configuration

  12. * Per user settings

  13. * Related projects & alternatives

  14. * Maintainers

  15. 

  16. 

  17. INTRODUCTION

  18. ------------

  19. 

  20. Notify is a simple, lightweight module for sending plain text e-mail

  21. notifications about new content and comments posted on a Drupal web

  22. site.

  23. 

  24. * For a full description of the module, visit the project page:

  25.   https://drupal.org/project/notify

  26. 

  27. * For more documentation about its use, visit the documentation page:

  28.   https://www.drupal.org/documentation/modules/notify

  29. 

  30. * To submit bug reports and feature suggestions, or to track changes:

  31.   https://drupal.org/project/issues/notify

  32. 

  33. If you enable node revisions (https://www.drupal.org/node/320614), the

  34. notification e-mail will also mention the name of the last person to

  35. edit the node.

  36. 

  37. 

  38. REQUIREMENTS

  39. ------------

  40. 

  41. This module requires a supported version of Drupal and cron to be

  42. running at least as frequently as you want to send out notifications.

  43. 

  44. 

  45. INSTALLATION

  46. ------------

  47. 

  48. 1. Install Notify as you would normally install a contributed Drupal

  49.    module.

  50. 

  51. 2. Enable Notify module by locating it on the list under the Extend

  52.    tab in the administrative GUI. The tables will be created

  53.    automagically for you at this point.

  54. 

  55. 3. Modify permissions on the People » Permissions page.

  56. 

  57.    To set the notification checkbox default on new user registration

  58.    form, or let new users opt in for notifications during

  59.    registration, you must grant the anonymous user the right to access

  60.    Notify.

  61. 

  62. 4. Configure general notification settings.  See the "Configuration"

  63.    section below for details.

  64. 

  65. 

  66. CONFIGURATION

  67. -------------

  68. 

  69. The administrative interface is at: Administration » Configuration »

  70. People » Notify settings.

  71. 

  72. - The "Settings" tab is for setting how often notifications are sent.

  73. 

  74. - The and "Default settings" tab is to set up default presets for new

  75.   users, and for selecting permitted notification by node type.

  76. 

  77. - The "Users" tab is to review and see per-user settings.

  78. 

  79. - The remaining to tabs ("Queue" and "Skip flags") are for managing

  80.   the notification queue.

  81. 

  82. When setting how often notifications are sent, note that e-mail

  83. updates can only happen as frequently as the cron is set to run.

  84. Check your cron settings.

  85. 

  86. 

  87. PER USER SETTINGS

  88. -----------------

  89. 

  90. To manage your own notification preferences, click on the

  91. "Notification settings" on your "My account" page.

  92. 

  93. 

  94. RELATED PROJECTS & ALTERNATIVES

  95. -------------------------------

  96. 

  97. The Mailchimp project (https://www.drupal.org/project/mailchimp)

  98. provides integration with external Mailchimp email delivery

  99. service. It can be set up to produce a formatted HTML newsletter based

  100. upon the site's RSS-feed.

  101. 

  102. Also see the section "Similar Modules" on the project page for links

  103. to paged listing other newsletter and email notification modules.

  104. 

  105. 

  106. MAINTAINERS

  107. -----------

  108. 

  109. Kjartan Mannes  is the original author.

  110. Rob Barreca  was a previous maintainer.

  111. Matt Chapman  is the project owner.

  112. Gisle Hannemyr  maintains the Drupal 7 branch.

  113. 

  114. Marton Bodonyi (http://www.interactivejunky.com/),

  115. Mark Lindsey,

  116. John Oltman ,

  117. Ward Poelmans ,

  118. Ishmael Sanchez (http://ishmaelsanchez.com), and

  119. Ajit Shinde (https://www.facebook.com/shinde.ajit)

  120. contributed to the Drupal 7 port.

  121. Vincent Rommelaars  contributed to the Drupal 8

  122. port.