Application Programming Interface (API)

Sympa provides a SOAP application programming interface (API), 

• https://sympa-community.github.io/manual/customize/soap-api.html

A precise and accurate definition of the methods which are provided can be found at:

• https://lists.cam.ac.uk/sympa/wsdl

In the following examples dpc22+soap@cam.ac.uk is a local  account which has been created on Sympa using https://lists.cam.ac.uk/sympa/firstpasswd

(Local Login -> First Login -> Request first password)

 Role email addresses can be used, and are recommended when several different people or entities need to update a list. The nominated account is then added to the list in question as a normal list owner with "no notifications" and "concealed from list menu" set.

This folder contains a pair of example scripts written in Python and Perl which can be used interchangeably to synchronise the membership of a list with a file stored on your local workstation.

This seems to be the most common requirement for scripted access to Mailing lists. Examples in other programming languages and requests/examples for other common tasks are welcome: please contact postmaster@lists.cam.ac.uk

Please remember that Sympa Data Sources allow you synchronise directly with external data sources such as Blue AD. This may be simpler as the lists are automatically updated. The list members defined by external data sources are also kept separate from the normal list membership.

Python: sync.py

$ ./sync.py test-dpc22 dpc22+soap@cam.ac.uk emails
dpc22+soap@cam.ac.uk Password:
Adding: dpc22@cam.ac.uk
Adding: dpc99@cam.ac.uk

$ ./sync.py test-dpc22 dpc22+soap@cam.ac.uk empty
dpc22+soap@cam.ac.uk Password:
Removing: dpc22@cam.ac.uk
Removing: dpc99@cam.ac.uk

Perl: sync.pl

$ ./sync.pl test-dpc22 dpc22+soap@cam.ac.uk emails
dpc22+soap@cam.ac.uk Password:
Adding: dpc22@cam.ac.uk
Adding: dpc99@cam.ac.uk

$ ./sync.pl test-dpc22 dpc22+soap@cam.ac.uk empty
dpc22+soap@cam.ac.uk Password:
Removing: dpc22@cam.ac.uk
Removing: dpc99@cam.ac.uk