[squirrelmail.git] / plugins / listcommands / README

List Commands plugin

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
============

Go to the main directory, run configure and add the plugin.


Acknowledgements
================
The listcommands plugin has been originally created by Thijs Kinkhorst and is
now under the control of the SquirrelMail Project Team.

I'd like to thank Peter Walker, Wouter Teepe, Jason Edwards and Phillipe Mingo
for their useful contributions to this plugin.
Commit	Line	Data
e29a0356	1	List Commands plugin
73ee43b1	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
e29a0356	29	Go to the main directory, run configure and add the plugin.
050722c4	30
73ee43b1	31
	32	Acknowledgements
	33	================
e29a0356	34	The listcommands plugin has been originally created by Thijs Kinkhorst and is
	35	now under the control of the SquirrelMail Project Team.
	36
050722c4	37	I'd like to thank Peter Walker, Wouter Teepe, Jason Edwards and Phillipe Mingo
050722c4	38	for their useful contributions to this plugin.