Add preview pane to advanced default template. This serves as an example of how...
[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 through the browser whenever 
3 the user has unseen messages flagged in the left window pane. There are options 
4 available (on the options page of course) to disable this feature for each user, 
5 and to select different media files from the users local computer. The default 
6 is that this is NOT enabled, so you'll need to go to the options menu to turn 
7 it on first! There are also options to show a popup window via JavaScript.
8
9 Plugin options are visible only when JavaScript is enabled or detected by
10 SquirrelMail JavaScript detection functions.
11
12 From SquirrelMail 1.5.1 newmail plugin's site configuration can be stored in
13 config/newmail_config.php or plugins/newmail/config.php.
14
15 $allowsound setting is replaced with $newmail_allowsound and should be stored
16 inside plugin's site configuration file.
17
18 Plugin supports playback of WAV, SWF, MP3, OGG and SVG media files. Currently
19 OGG and SVG files are played only by browsers that implement w3.org nested 
20 objects correctly and browsers that can play <embed> objects. Internet Explorer 
21 can't play them due to broken <object> implementation. OGG and SVG <object> 
22 elements specific to IE are not implemented.
23
24 CREDITS
25
26 This plugin has been originally created by Mike Huttinger, with contributions by
27 Tyler Akins and Seth Randall. It's now maintained by the SquirrelMail Project
28 Team.