Revise plugin documentation. Mainly, this removes remains of documentation
[squirrelmail.git] / plugins / newmail / README
1 This plugin is used to play sounds (currently a WAV file) through the
2 browser whenever the user has unseen messages flagged in the left window
3 pane.  There are options available (on the options page of course) to
4 disable this feature for each user, and to select different media files
5 from the users local computer.  The default is that this is NOT enabled,
6 so you'll need to go to the options menu to turn it on first! There are
7 also options to show a popup window via JavaScript.
8
9 From SquirrelMail 1.5.1 newmail plugin's site configuration can be stored in
10 config/newmail_config.php or plugins/newmail/config.php.
11
12 $allowsound setting is replaced with $newmail_allowsound and should be stored
13 inside plugin's site configuration file.
14
15
16 CREDITS
17
18 This plugin has been originally created by Mike Huttinger, with contributions
19 by Tyler Akins and Seth Randall. It's now maintained by the SquirrelMail
20 Project Team.