List Commands plugin by "Thijs Kinkhorst" <thijs@kinkhorst.com>

[squirrelmail.git] / plugins / listcommands / README

diff --git a/plugins/listcommands/README b/plugins/listcommands/README
new file mode 100644 (file)
index 0000000..a5a597c
--- /dev/null
+++ b/plugins/listcommands/README
@@ -0,0 +1,52 @@
+List Commands plugin -- v1.2
+
+This plugin gives the user a menu of mailinglist options such as
+(un)subscribe, help and archives when viewing messages from compliant
+mailinglists.
+
+
+Description
+===========
+
+The plugin is an implementation of RFC 2369, "The Use of URLs as Meta-Syntax
+for Core Mail List Commands and their Transport through Message Header Fields",
+to be found at ftp://nis.nsf.net/internet/documents/rfc/rfc2369.txt.
+
+Compliant mailinglistservers add extra headers with each message they send out
+with information about how to (un)subscribe, get help or contact the list
+owner. This can either be a web location or an emailaddress. In the latter
+case, one needs to send an email to that address in order to complete an action
+like subscribing.
+
+The information in these headers is used to generate an extra menuline on
+messages containing one or more of these headers to help users taking advantage
+of the features offered.
+
+
+Installation
+============
+
+As with other plugins, just uncompress the archive in the plugins
+directory, go back to the main directory, run configure and add the plugin.
+
+Questions/comments/flames/etc can be sent to
+    Thijs Kinkhorst <thijs@kinkhorst.com>
+
+
+Changes
+=======
+1.0
+ * Initial version
+1.1
+ * Added 'Reply to list' option
+ * Support for identities when sending mail
+ * Miscelaneous minor improvements
+1.2
+ * Fixed too greedy regexp; changed to PCRE.
+ * Fixed IMAP session id handling.
+ 
+
+Acknowledgements
+================
+I'd like to thank Peter Walker, Wouter Teepe and Jason Edwards for their
+useful contributions to this plugin.