X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=plugins%2Fnewmail%2FREADME;h=a4561e95c1f3d021560828ec2890bb393a1c59ba;hp=50b46d06fd36e23e13c36b81d1998cd3dd994990;hb=de3178dc1a5117827e254544c6f164dba653ad83;hpb=7aa2227615dd0453b7d07d8c01cb946b5d3caf0a diff --git a/plugins/newmail/README b/plugins/newmail/README index 50b46d06..a4561e95 100644 --- a/plugins/newmail/README +++ b/plugins/newmail/README @@ -1,10 +1,13 @@ -This plugin is used to play sounds (currently a WAV file) through the -browser whenever the user has unseen messages flagged in the left window -pane. There are options available (on the options page of course) to -disable this feature for each user, and to select different media files -from the users local computer. The default is that this is NOT enabled, -so you'll need to go to the options menu to turn it on first! There are -also options to show a popup window via JavaScript. +This plugin is used to notify the user when a new mail arrives. There are +several ways to do this. One is to play a sound through the browser whenever +the user has unseen messages flagged in the left window pane. There are options +available (on the options page of course) to disable this feature for each user, +and to select different media files from the users local computer. The default +is that this is NOT enabled, so you'll need to go to the options menu to turn +it on first! There are also options to show a popup window via JavaScript. + +Plugin options are visible only when JavaScript is enabled or detected by +SquirrelMail JavaScript detection functions. From SquirrelMail 1.5.1 newmail plugin's site configuration can be stored in config/newmail_config.php or plugins/newmail/config.php. @@ -12,9 +15,14 @@ config/newmail_config.php or plugins/newmail/config.php. $allowsound setting is replaced with $newmail_allowsound and should be stored inside plugin's site configuration file. +Plugin supports playback of WAV, SWF, MP3, OGG and SVG media files. Currently +OGG and SVG files are played only by browsers that implement w3.org nested +objects correctly and browsers that can play objects. Internet Explorer +can't play them due to broken implementation. OGG and SVG +elements specific to IE are not implemented. CREDITS -This plugin has been originally created by Mike Huttinger, with contributions -by Tyler Akins and Seth Randall. It's now maintained by the SquirrelMail -Project Team. +This plugin has been originally created by Mike Huttinger, with contributions by +Tyler Akins and Seth Randall. It's now maintained by the SquirrelMail Project +Team.