[summerofcode] Remote Control of Mailman using REST

Rich Cowan richcowan at gmail.com
Mon Jun 13 21:09:06 CEST 2005


I looked at the list of proposed Python projects, and lots of it was
internal stuff -- it seems to me that someone ought to be thinking
about extending python OSS apps to make them more useful to others.

In this spirit, I want to propose a task for a Google Summer of Code
project:  to add an API to the Mailman user interface.  If
upcoming.org can do it, why not Mailman?

Here is a sample list of basic methods that could be implemented.

Let me know what you think!  If these were implemented we could then
implement control of mailman from a desktop application we have
developed, which would be very useful.

-rich

www.organizerscollaborative.org


Methods

list
list.add [HTTP POST]     (add a new list, need to include admin email
and password, name of list, etc)
list.delete [HTTP POST]     (delete existing list)
list.getinfo [HTTP GET]   (returns # of subscribers, traffic, admin name)
list.masssubscribe [HTTP POST]  (bulk subscribe)
list.massunsubscribe [HTTP POST]  (bulk unsubscribe)
list.clear [HTTP POST]  (delete all subscribers)
list.getbounces [HTTP POST]  (retrieve list of suspect emails)
list.purgebounces [HTTP POST]  (force the removal of some or all suspect emails)

subscriber
subscriber.subscribe [HTTP POST]     (add a new subscriber if unique)
subscriber.unsubscribe [HTTP POST]     (delete existing subscriber)
subscriber.setdigest [HTTP POST]   (set mode to digest for subscriber )
subscriber.setnodigest [HTTP POST]   (set mode to normal for subscriber )
subscriber.search [HTTP GET]   (get list of subscribers matching substring)
subscriber.setname [HTTP POST]  (set the first and last name for a subscriber)
subscriber.getname [HTTP GET]    (get the first and last name for a subscriber)

hope someone has been thinking of doing this...  this is the type of
thing that the developers of upcoming.org chose to implement  (see below).
I have already suggested this to the civicspace project, but I am thinking
that perhaps some progress has already been made somewhere on this...

-rich cowan
 www.organizerscollaborative.org



see also http://upcoming.org/services/api/ :

Overview

Upcoming.org's open API currently supports a RESTful interface, that
essentially means you can send an HTTP GET or POST to call exposed
methods, and you'll get back an XML document in return.

When you send a request, you'll get a response in XML that looks like this:

<rsp stat="ok" version="1.0">
	[Data in XML format - see individual method docs]
</rsp>

If there's an error, the service gateway will respond with an HTTP
error code, and an error message about the problem.

<rsp stat="fail">
	<error msg="Error Message" />
<rsp>


More information about the summerofcode mailing list