Included newmail for officialization 8)

[squirrelmail.git] / plugins / newmail / README

diff --git a/plugins/newmail/README b/plugins/newmail/README
new file mode 100644 (file)
index 0000000..ea6fb67
--- /dev/null
+++ b/plugins/newmail/README
@@ -0,0 +1,42 @@
+Ok, this is my first attempt at a plugin, so excuse the mess you may find
+in here.
+
+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.
+
+I tried to make this fairly simple to install.  To install the plugin:
+
+  1.  Change to the plugins directory.
+
+        $ cd plugins/
+
+  2.  Unarchive the plugin.
+
+        $ tar zxvf /your/path/to/newmail-x.x.tgz
+
+  2.  This should create a newmail/ directory under plugins.
+
+  4.  Go to the config directory and run conf.pl
+
+        $ cd ../../config/
+        $ ./conf.pl
+
+  5.  Choose option 8 and proceed to add the new plugin following
+      the instructions there.  Save and exit, and your plugin should
+      be in place.
+
+Any questions, you can let me know --
+
+Mike Huttinger
+huttinger@ipact.com
+
+-----------------------------------------
+
+Modifications by Tyler Akins to support changing the title bar and for the
+new 1.1.1 validate.php format.  Also uses the new sqimap_unseen_messages()
+function in 1.1.2