Included newmail for officialization 8)
[squirrelmail.git] / plugins / newmail / README
1 Ok, this is my first attempt at a plugin, so excuse the mess you may find
2 in here.
3
4 This plugin is used to play sounds (currently a WAV file) through the
5 browser whenever the user has unseen messages flagged in the left window
6 pane.  There are options available (on the options page of course) to
7 disable this feature for each user, and to select different media files
8 from the users local computer.  The default is that this is NOT enabled,
9 so you'll need to go to the options menu to turn it on first! There are
10 also options to show a popup window via JavaScript.
11
12 I tried to make this fairly simple to install.  To install the plugin:
13
14   1.  Change to the plugins directory.
15
16         $ cd plugins/
17
18   2.  Unarchive the plugin.
19
20         $ tar zxvf /your/path/to/newmail-x.x.tgz
21
22   2.  This should create a newmail/ directory under plugins.
23
24   4.  Go to the config directory and run conf.pl
25
26         $ cd ../../config/
27         $ ./conf.pl
28
29   5.  Choose option 8 and proceed to add the new plugin following
30       the instructions there.  Save and exit, and your plugin should
31       be in place.
32
33 Any questions, you can let me know --
34
35 Mike Huttinger
36 huttinger@ipact.com
37
38 -----------------------------------------
39
40 Modifications by Tyler Akins to support changing the title bar and for the
41 new 1.1.1 validate.php format.  Also uses the new sqimap_unseen_messages()
42 function in 1.1.2