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