withlist − General framework for interacting with a mailing list object.


withlist [options] listname [args ...]

There are two ways to use this script: interactively or programmatically. Using it interactively allows you to play with, examine and modify a MailList object from Python’s interactive interpreter. When running interactively, a MailList object called ‘m’ will be available in the global namespace. It also loads the class MailList into the global namespace.

Programmatically, you can write a function to operate on a MailList object, and this script will take care of the housekeeping (see below for examples). In that case, the general usage syntax is:


−l, −−lock

Lock the list when opening. Normally the list is opened unlocked (e.g. for read-only operations). You can always lock the file after the fact by typing ‘m.Lock()’

Note that if you use this option, you should explicitly call m.Save() before exiting, since the interpreter’s clean up procedure will not automatically save changes to the MailList object (but it will unlock the list).

−i, −−interactive

Leaves you at an interactive prompt after all other processing is complete. This is the default unless the −r option is given.

−r [module.]callable, −−run [module.]callable

This can be used to run a script with the opened MailList object. This works by attempting to import module (which must already be accessible on your sys.path), and then calling callable from the module. callable can be a class or function; it is called with the MailList object as the first argument. If additional args are given on the command line, they are passed as subsequent positional args to the callable.

Note that module. is optional; if it is omitted then a module with the name callable will be imported.

The global variable ‘r’ will be set to the results of this call.

−a, −−all

This option only works with the −r option. Use this if you want to execute the script on all mailing lists. When you use −a you should not include a listname argument on the command line. The variable ‘r’ will be a list of all the results.

−q, −−quiet

Suppress all status messages.

−h, −−help

Print a small help text and exit


Here’s an example of how to use the −r option. Say you have a file in the Mailman installation directory called ‘listaddr.py’, with the following two functions:

def listaddr(mlist):
print mlist.GetListEmail()

def requestaddr(mlist):
print mlist.GetRequestEmail()

Now, from the command line you can print the list’s posting address by running the following from the command line:

% bin/withlist -r listaddr mylist
Loading list: mylist (unlocked)
Importing listaddr ...
Running listaddr.listaddr() ...

And you can print the list’s request address by running:

% bin/withlist -r listaddr.requestaddr mylist
Loading list: mylist (unlocked)
Importing listaddr ...
Running listaddr.requestaddr() ...

As another example, say you wanted to change the password for a particular user on a particular list. You could put the following function in a file called ‘changepw.py’:

from Mailman.Errors import NotAMemberError

def changepw(mlist, addr, newpasswd):
mlist.setMemberPassword(addr, newpasswd)
except NotAMemberError:
print ’No address matched:’, addr

and run this from the command line:
% bin/withlist -l -r changepw mylist somebody@somewhere.org foobar


Author of Mailman is the Mailman Cabal, see http://www.list.org/ for information. This manpage is written for Debian by Bernd S. Brentrup <bsb@debian.org>.


Mailman documentation on http://www.list.org/ and in /usr/share/doc/mailman.


Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.


Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.