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