update README to reflect inclusion in squirrelmail-core-plugins
[squirrelmail.git] / plugins / listcommands / README
1 List Commands plugin
2
3 This plugin gives the user a menu of mailinglist options such as
4 (un)subscribe, help and archives when viewing messages from compliant
5 mailinglists.
6
7
8 Description
9 ===========
10
11 The plugin is an implementation of RFC 2369, "The Use of URLs as Meta-Syntax
12 for Core Mail List Commands and their Transport through Message Header Fields",
13 to be found at ftp://nis.nsf.net/internet/documents/rfc/rfc2369.txt.
14
15 Compliant mailinglistservers add extra headers with each message they send out
16 with information about how to (un)subscribe, get help or contact the list
17 owner. This can either be a web location or an emailaddress. In the latter
18 case, one needs to send an email to that address in order to complete an action
19 like subscribing.
20
21 The information in these headers is used to generate an extra menuline on
22 messages containing one or more of these headers to help users taking advantage
23 of the features offered.
24
25
26 Installation
27 ============
28
29 Go to the main directory, run configure and add the plugin.
30
31
32 Acknowledgements
33 ================
34 The listcommands plugin has been originally created by Thijs Kinkhorst and is
35 now under the control of the SquirrelMail Project Team.
36
37 I'd like to thank Peter Walker, Wouter Teepe, Jason Edwards and Phillipe Mingo
38 for their useful contributions to this plugin.