Mailman Client¶

The mailmanclient library provides official Python bindings for the GNU Mailman 3 REST API.

Requirements¶

mailmanclient requires Python 2.7 or newer.

Documentation¶

A simple guide to using the library is available within this package, in the form of doctests. The manual is also available online at:

http://mailmanclient.readthedocs.org/en/latest/

Project details¶

The project home page is:

https://gitlab.com/mailman/mailmanclient

You should report bugs at:

https://gitlab.com/mailman/mailmanclient/issues

You can download the latest version of the package either from the Cheese Shop:

http://pypi.python.org/pypi/mailmanclient

or from the GitLab page above. Of course you can also just install it with pip from the command line:

$ pip install mailmanclient

You can grab the latest development copy of the code using Git, from the Gitlab home page above. If you have Git installed, you can grab your own branch of the code like this:

$ git clone https://gitlab.com/mailman/mailmanclient.git

You may contact the developers via mailman-developers@python.org

Acknowledgements¶

Many thanks to Florian Fuchs for his contribution of an initial REST client. Also thanks to all the contributors of Mailman Client who have contributed code, raised issues or devoted their time in any capacity!

NEWS for mailmanclient¶

3.1.1 (2017-10-07)¶

Python3 compatibility is fixed, mailmanclient is now compatible through Python2.7 - Python3.6

Internal source code is now split into several class-specific modules as compared to previously a single giant _client module.

All the RestObjects, like MailingList, are now exposed from the top level import.

Old mailmanclient._client module is added back for compatibility with versions of Postorius that use some internal APIs.

3.1 (2017-05-25)¶

Bug fixes.

Align with Mailman 3.1 Core REST API.

Python3 compatibility is broken because of a urllib bug.

1.0.1 (2015-11-14)¶

Bugfix release.

1.0.0 (2015-04-17)¶

Port to Python 3.4.

Run test suite with tox.

Use vcrpy for HTTP testing.

Add list archiver access.

Add subscription moderation

1.0.0a1 (2014-03-15)¶

Initial release.

Example Usage¶

This is the official Python bindings for the GNU Mailman REST API. In order to talk to Mailman, the engine’s REST server must be running. You begin by instantiating a client object to access the root of the REST hierarchy, providing it the base URL, user name and password (for Basic Auth).

>>> from mailmanclient import Client
>>> client = Client('http://localhost:9001/3.1', 'restadmin', 'restpass')

Note

Please note that port ‘9001’ is used above, since mailman’s test server runs on port 9001. In production Mailman’s REST API usually listens on port 8001.

We can retrieve basic information about the server.

>>> dump(client.system)
api_version: 3.1
http_etag: "..."
mailman_version: GNU Mailman ... (...)
python_version: ...
self_link: http://localhost:9001/3.1/system/versions

To start with, there are no known mailing lists.

>>> client.lists
[]

Domains¶

Before new mailing lists can be added, the domain that the list will live in must be added. By default, there are no known domains.

>>> client.domains
[]

It’s easy to create a new domain; when you do, a proxy object for that domain is returned.

>>> example_dot_com = client.create_domain('example.com')
>>> example_dot_com
<Domain "example.com">
>>> print(example_dot_com.description)
None
>>> print(example_dot_com.mail_host)
example.com

You can also get an existing domain independently using its mail host.

>>> example = client.get_domain('example.com')
>>> example
<Domain "example.com">

After creating a few more domains, we can print the list of all domains.

>>> client.create_domain('example.net')
<Domain "example.net">
>>> example_org = client.create_domain('example.org')
>>> print(example_org)
<Domain "example.org">
>>> for mail_host in client.domains:
...     print(mail_host)
<Domain "example.com">
<Domain "example.net">
<Domain "example.org">

Also, domain can be deleted.

>>> example_org.delete()
>>> for mail_host in client.domains:
...     print(mail_host)
<Domain "example.com">
<Domain "example.net">

Mailing lists¶

Once you have a domain, you can create mailing lists in that domain.

>>> test_one = example.create_list('test-1')
>>> test_one
<List "test-1@example.com">
>>> print(test_one.fqdn_listname)
test-1@example.com
>>> print(test_one.mail_host)
example.com
>>> print(test_one.list_name)
test-1
>>> print(test_one.display_name)
Test-1

You can also retrieve the mailing list after the fact.

>>> my_list = client.get_list('test-1@example.com')
>>> my_list
<List "test-1@example.com">

And you can print all the known mailing lists.

>>> example.create_list('test-2')
<List "test-2@example.com">
>>> domain = client.get_domain('example.net')
>>> domain.create_list('test-3')
<List "test-3@example.net">
>>> example.create_list('test-3')
<List "test-3@example.com">

>>> for mlist in client.lists:
...     print(mlist)
<List "test-1@example.com">
<List "test-2@example.com">
<List "test-3@example.com">
<List "test-3@example.net">

You can also select advertised lists only.

>>> my_list.settings['advertised'] = False
>>> my_list.settings.save()
>>> for mlist in client.get_lists(advertised=True):
...     print(mlist)
<List "test-2@example.com">
<List "test-3@example.com">
<List "test-3@example.net">

List results can be retrieved as pages:

>>> page = client.get_list_page(count=2, page=1)
>>> page.nr
1
>>> len(page)
2
>>> page.total_size
4
>>> for m_list in page:
...     print(m_list)
<List "test-1@example.com">
<List "test-2@example.com">
>>> page = page.next
>>> page.nr
2
>>> for m_list in page:
...     print(m_list)
<List "test-3@example.com">
<List "test-3@example.net">

Pages can also use the advertised filter:

>>> page = client.get_list_page(count=2, page=1, advertised=True)
>>> for m_list in page:
...     print(m_list)
<List "test-2@example.com">
<List "test-3@example.com">

If you only want to know all lists for a specific domain, use the domain object.

>>> for mlist in example.lists:
...     print(mlist)
<List "test-1@example.com">
<List "test-2@example.com">
<List "test-3@example.com">

It is also possible to display only advertised lists when using the domain.

>>> for mlist in example.get_lists(advertised=True):
...     print(mlist)
<List "test-2@example.com">
<List "test-3@example.com">
>>> for mlist in example.get_list_page(count=2, page=1, advertised=True):
...     print(mlist)
<List "test-2@example.com">
<List "test-3@example.com">

You can use a list instance to delete the list.

>>> test_three = client.get_list('test-3@example.net')
>>> test_three.delete()

You can also delete a list using the client instance’s delete_list method.

>>> client.delete_list('test-3@example.com')

>>> for mlist in client.lists:
...     print(mlist)
<List "test-1@example.com">
<List "test-2@example.com">

Membership¶

Email addresses can subscribe to existing mailing lists, becoming members of that list. The address is a unique id for a specific user in the system, and a member is a user that is subscribed to a mailing list. Email addresses need not be pre-registered, though the auto-registered user will be unique for each email address.

The system starts out with no members.

>>> client.members
[]

New members can be easily added; users are automatically registered.

>>> test_two = client.get_list('test-2@example.com')
>>> print(test_two.settings['subscription_policy'])
confirm

Email addresses need to be verified first, so if we try to subscribe a user, we get a response with a token:

>>> data = test_one.subscribe('unverified@example.com', 'Unverified')
>>> data['token'] is not None
True
>>> print(data['token_owner'])
subscriber

If we know the email address to be valid, we can set the pre_verified flag. However, the list’s subscription policy is “confirm”, so if we try to subscribe a user, we will also get a token back:

>>> data = test_one.subscribe('unconfirmed@example.com',
...                           'Unconfirmed',
...                            pre_verified=True)
>>> data['token'] is not None
True
>>> print(data['token_owner'])
subscriber

If we know the user originated the subscription (for example if she or he has been authenticated elsewhere), we can set the pre_confirmed flag.

The pre_approved flag is used for lists that require moderator approval and should only be used if the subscription is initiated by a moderator or admin.

>>> test_one.subscribe('anna@example.com', 'Anna',
...                    pre_verified=True,
...                    pre_confirmed=True)
<Member "anna@example.com" on "test-1.example.com">

>>> test_one.subscribe('bill@example.com', 'Bill',
...                    pre_verified=True,
...                    pre_confirmed=True)
<Member "bill@example.com" on "test-1.example.com">

>>> test_two.subscribe('anna@example.com',
...                    pre_verified=True,
...                    pre_confirmed=True)
<Member "anna@example.com" on "test-2.example.com">

>>> test_two.subscribe('cris@example.com', 'Cris',
...                    pre_verified=True,
...                    pre_confirmed=True)
<Member "cris@example.com" on "test-2.example.com">

We can retrieve all known memberships. These are sorted first by mailing list name, then by email address.

>>> for member in client.members:
...     print(member)
<Member "anna@example.com" on "test-1.example.com">
<Member "bill@example.com" on "test-1.example.com">
<Member "anna@example.com" on "test-2.example.com">
<Member "cris@example.com" on "test-2.example.com">

We can also view the memberships for a single mailing list.

>>> for member in test_one.members:
...     print(member)
<Member "anna@example.com" on "test-1.example.com">
<Member "bill@example.com" on "test-1.example.com">

Membership lists can be paginated, to recieve only a part of the result.

>>> page = client.get_member_page(count=2, page=1)
>>> page.nr
1
>>> page.total_size
4
>>> for member in page:
...     print(member)
<Member "anna@example.com" on "test-1.example.com">
<Member "bill@example.com" on "test-1.example.com">

>>> page = page.next
>>> page.nr
2
>>> for member in page:
...     print(member)
<Member "anna@example.com" on "test-2.example.com">
<Member "cris@example.com" on "test-2.example.com">

>>> page = test_one.get_member_page(count=1, page=1)
>>> page.nr
1
>>> page.total_size
2
>>> for member in page:
...     print(member)
<Member "anna@example.com" on "test-1.example.com">
>>> page = page.next
>>> page.nr
2
>>> page.total_size
2
>>> for member in page:
...     print(member)
<Member "bill@example.com" on "test-1.example.com">

We can get a single membership too.

>>> cris_test_two = test_two.get_member('cris@example.com')
>>> cris_test_two
<Member "cris@example.com" on "test-2.example.com">
>>> print(cris_test_two.role)
member

A membership can also be retrieved without instantiating the list object first:

>>> client.get_member('test-2@example.com', 'cris@example.com')
<Member "cris@example.com" on "test-2.example.com">

A membership has preferences.

>>> prefs = cris_test_two.preferences
>>> print(prefs['delivery_mode'])
None
>>> print(prefs['acknowledge_posts'])
None
>>> print(prefs['delivery_status'])
None
>>> print(prefs['hide_address'])
None
>>> print(prefs['preferred_language'])
None
>>> print(prefs['receive_list_copy'])
None
>>> print(prefs['receive_own_postings'])
None

The membership object’s user attribute will return a User object:

>>> cris_test_two.user
<User "Cris" (...)>

If you use an address which is not a member of test_two ValueError is raised:

>>> test_two.unsubscribe('nomember@example.com')
Traceback (most recent call last):
...
ValueError: nomember@example.com is not a member address of test-2@example.com

After a while, Anna decides to unsubscribe from the Test One mailing list, though she keeps her Test Two membership active.

>>> import time
>>> time.sleep(2)
>>> test_one.unsubscribe('anna@example.com')
>>> for member in client.members:
...     print(member)
<Member "bill@example.com" on "test-1.example.com">
<Member "anna@example.com" on "test-2.example.com">
<Member "cris@example.com" on "test-2.example.com">

A little later, Cris decides to unsubscribe from the Test Two mailing list.

>>> cris_test_two.unsubscribe()
>>> for member in client.members:
...     print(member)
<Member "bill@example.com" on "test-1.example.com">
<Member "anna@example.com" on "test-2.example.com">

If you try to unsubscribe an address which is not a member address ValueError is raised:

>>> test_one.unsubscribe('nomember@example.com')
Traceback (most recent call last):
...
ValueError: nomember@example.com is not a member address of test-1@example.com

Non-Members¶

When someone attempts to post to a list but is not a member, then they are listed as a “non-member” of that list so that a moderator can choose how to handle their messages going forward. In some cases, one might wish to accept or reject their future messages automatically. Just like with regular members, they are given a unique id.

The list starts out with no nonmembers.

>>> test_one.nonmembers
[]

When someone tries to send a message to the list and they are not a subscriber, they get added to the nonmember list.

Users¶

Users are people with one or more list memberships. To get a list of all users, access the clients user property.

>>> for user in client.users:
...     print(user)
<User "..." (...)>
<User "..." (...)>
<User "..." (...)>

The list of users can also be paginated:

>>> page = client.get_user_page(count=4, page=1)
>>> page.nr
1
>>> page.total_size
5

>>> for user in page:
...     print(user)
<User "Unverified" (...)>
<User "Unconfirmed" (...)>
<User "Anna" (...)>
<User "Bill" (...)>

You can get the next or previous pages without calling get_userpage again.

>>> page = page.next
>>> page.nr
2

>>> for user in page:
...     print(user)
<User "Cris" (...)>

>>> page = page.previous
>>> page.nr
1

>>> for user in page:
...     print(user)
<User "Unverified" (...)>
<User "Unconfirmed" (...)>
<User "Anna" (...)>
<User "Bill" (...)>

A single user can be retrieved using their email address.

>>> cris = client.get_user('cris@example.com')
>>> print(cris.display_name)
Cris

Every user has a list of one or more addresses.

>>> for address in cris.addresses:
...     print(address)
...     print(address.display_name)
...     print(address.registered_on)
cris@example.com
Cris
...

Multiple addresses can be assigned to a user record:

>>> cris.add_address('cris.person@example.org')
cris.person@example.org
>>> print(client.get_address('cris.person@example.org'))
cris.person@example.org

>>> for address in cris.addresses:
...     print(address)
cris.person@example.org
cris@example.com

Trying to add an existing address will raise an error:

>>> client.create_user(email='dana@example.org',
...                    password='somepass',
...                    display_name='Dana')
<User "Dana" (...)>
>>> cris.add_address('dana@example.org')  
Traceback (most recent call last):
...
HTTPError: HTTP Error 400: Address already exists

This can be overridden by using the absorb_existing flag:

>>> cris.add_address('dana@example.org', absorb_existing=True)
dana@example.org

The user Chris will then be merged with Dana, acquiring all its subscriptions and preferences. In case of conflict, Chris’ original preferences will prevail.

>>> for address in cris.addresses:
...     print(address)
cris.person@example.org
cris@example.com
dana@example.org

Addresses¶

Addresses can be accessed directly:

>>> address = client.get_address('dana@example.org')
>>> print(address)
dana@example.org
>>> print(address.display_name)
Dana

The address has not been verified:

>>> print(address.verified)
False

But that can be done via the address object:

>>> address.verify()
>>> print(address.verified)
True

It can also be unverified:

>>> address.unverify()
>>> print(address.verified)
False

Addresses can be deleted by calling their delete() method or by removing them from their user’s addresses list:

>>> cris.addresses.remove('dana@example.org')
>>> for address in cris.addresses:
...     print(address)
cris.person@example.org
cris@example.com

Users can be added using create_user. The display_name is optional:

>>> client.create_user(email='ler@primus.org',
...                    password='somepass',
...                    display_name='Ler')
<User "Ler" (...)>
>>> ler = client.get_user('ler@primus.org')
>>> print(ler.password)
$...
>>> print(ler.display_name)
Ler

User attributes can be changed through assignment, but you need to call the object’s save method to store the changes in the mailman core database.

>>> ler.display_name = 'Sir Ler'
>>> ler.save()
>>> ler = client.get_user('ler@primus.org')
>>> print(ler.display_name)
Sir Ler

Passwords can be changed as well:

>>> old_pwd = ler.password
>>> ler.password = 'easy'
>>> old_pwd == ler.password
True
>>> ler.save()
>>> old_pwd == ler.password
False

User Subscriptions¶

A User’s subscriptions can be access through their subscriptions property.

>>> bill = client.get_user('bill@example.com')
>>> for subscription in bill.subscriptions:
...     print(subscription)
<Member "bill@example.com" on "test-1.example.com">

If all you need are the list ids of all mailing lists a user is subscribed to, you can use the subscription_list_ids property.

>>> for list_id in bill.subscription_list_ids:
...     print(list_id)
test-1.example.com

List Settings¶

We can get all list settings via a lists settings attribute. A proxy object for the settings is returned which behaves much like a dictionary.

>>> settings = test_one.settings
>>> len(settings)
56

>>> for attr in sorted(settings):
...     print(attr + ': ' + str(settings[attr]))
acceptable_aliases: []
...
volume: 1

>>> print(settings['display_name'])
Test-1

We can access all valid list settings as attributes.

>>> print(settings['fqdn_listname'])
test-1@example.com
>>> print(settings['description'])

>>> settings['description'] = 'A very meaningful description.'
>>> settings['display_name'] = 'Test Numero Uno'

>>> settings.save()

>>> settings_new = test_one.settings
>>> print(settings_new['description'])
A very meaningful description.
>>> print(settings_new['display_name'])
Test Numero Uno

The settings object also supports the get method of usual Python dictionaries:

>>> print(settings_new.get('OhNoIForgotTheKey',
...                        'HowGoodIPlacedOneUnderTheDoormat'))
HowGoodIPlacedOneUnderTheDoormat

Preferences¶

Preferences can be accessed and set for users, members and addresses.

By default, preferences are not set and fall back to the global system preferences. They’re read-only and can be accessed through the client object.

>>> global_prefs = client.preferences
>>> print(global_prefs['acknowledge_posts'])
False
>>> print(global_prefs['delivery_mode'])
regular
>>> print(global_prefs['delivery_status'])
enabled
>>> print(global_prefs['hide_address'])
True
>>> print(global_prefs['preferred_language'])
en
>>> print(global_prefs['receive_list_copy'])
True
>>> print(global_prefs['receive_own_postings'])
True

Preferences can be set, but you have to call save to make your changes permanent.

>>> prefs = test_two.get_member('anna@example.com').preferences
>>> prefs['delivery_status'] = 'by_user'
>>> prefs.save()
>>> prefs = test_two.get_member('anna@example.com').preferences
>>> print(prefs['delivery_status'])
by_user

Pipelines and Chains¶

The available pipelines and chains can also be retrieved:

>>> pipelines = client.pipelines['pipelines']
>>> for pipeline in pipelines:
...     print(pipeline)
default-owner-pipeline
default-posting-pipeline
virgin
>>> chains = client.chains['chains']
>>> for chain in chains:
...     print(chain)
accept
default-owner-chain
default-posting-chain
discard
header-match
hold
moderation
reject

Owners and Moderators¶

Owners and moderators are properties of the list object.

>>> test_one.owners
[]
>>> test_one.moderators
[]

Owners can be added via the add_owner method:

>>> test_one.add_owner('foo@example.com')
>>> for owner in test_one.owners:
...     print(owner)
foo@example.com

The owner of the list not automatically added as a member:

>>> test_one.members
[<Member "bill@example.com" on "test-1.example.com">]

Moderators can be added similarly:

>>> test_one.add_moderator('bar@example.com')
>>> for moderator in test_one.moderators:
...     print(moderator)
bar@example.com

Moderators are also not automatically added as members:

>>> test_one.members
[<Member "bill@example.com" on "test-1.example.com">]

Members and owners/moderators are separate entries in in the general members list:

>>> test_one.subscribe('bar@example.com', 'Bar',
...                    pre_verified=True,
...                    pre_confirmed=True)
<Member "bar@example.com" on "test-1.example.com">

>>> for member in client.members:
...     print('%s: %s' %(member, member.role))
<Member "foo@example.com" on "test-1.example.com">: owner
<Member "bar@example.com" on "test-1.example.com">: moderator
<Member "bar@example.com" on "test-1.example.com">: member
<Member "bill@example.com" on "test-1.example.com">: member
<Member "anna@example.com" on "test-2.example.com">: member

Both owners and moderators can be removed:

>>> test_one.remove_owner('foo@example.com')
>>> test_one.owners
[]
test_one.remove_moderator('bar@example.com‘) test_one.moderators []

Moderation¶

Subscription Moderation¶

Subscription requests can be accessed through the list object’s request property. So let’s create a non-open list first.

>>> confirm_first = example_dot_com.create_list('confirm-first')
>>> settings = confirm_first.settings
>>> settings['subscription_policy'] = 'moderate'
>>> settings.save()

>>> confirm_first = client.get_list('confirm-first.example.com')
>>> print(confirm_first.settings['subscription_policy'])
moderate

Initially there are no requests, so let’s to subscribe someone to the list. We’ll get a token back.

>>> confirm_first.requests
[]
>>> data = confirm_first.subscribe('groucho@example.com',
...                                pre_verified=True,
...                                pre_confirmed=True)
>>> print(data['token_owner'])
moderator

Now the request shows up in the list of requests:

>>> import time; time.sleep(5)
>>> len(confirm_first.requests)
1

>>> request_1 = confirm_first.requests[0]
>>> print(request_1['email'])
groucho@example.com
>>> print (request_1['token'] is not None)
True
>>> print(request_1['token_owner'])
moderator
>>> print(request_1['request_date'] is not None)
True
>>> print(request_1['list_id'])
confirm-first.example.com

Subscription requests can be accepted, deferred, rejected or discarded using the request token.

>>> data = confirm_first.subscribe('harpo@example.com',
...                                pre_verified=True,
...                                pre_confirmed=True)
>>> data = confirm_first.subscribe('zeppo@example.com',
...                                pre_verified=True,
...                                pre_confirmed=True)

>>> len(confirm_first.requests)
3

Let’s accept Groucho:

>>> response = confirm_first.moderate_request(request_1['token'], 'accept')
>>> len(confirm_first.requests)
2

>>> request_2 = confirm_first.requests[0]
>>> print(request_2['email'])
harpo@example.com

>>> request_3 = confirm_first.requests[1]
>>> print(request_3['email'])
zeppo@example.com

Let’s reject Harpo:

>>> response = confirm_first.moderate_request(request_2['token'], 'reject')
>>> len(confirm_first.requests)
1

Let’s discard Zeppo’s request:

>>> response = confirm_first.moderate_request(request_3['token'], 'discard')
>>> len(confirm_first.requests)
0

Message Moderation¶

By injecting a message by a non-member into the incoming queue, we can simulate a message being held for moderator approval.

>>> msg = """From: nomember@example.com
... To: test-1@example.com
... Subject: Something
... Message-ID: <moderated_01>
...
... Some text.
...
... """
>>> inq = client.queues['in']
>>> inq.inject('test-1.example.com', msg)

Now wait until the message has been processed.

>>> while True:
...     if len(inq.files) == 0:
...         break
...     time.sleep(0.1)

It might take a few moments for the message to show up in the moderation queue.

>>> while True:
...     all_held = test_one.held
...     if len(all_held) > 0:
...         break
...     time.sleep(0.1)

Messages held for moderation can be listed on a per list basis.

>>> print(all_held[0].request_id)
1

A held message can be retrieved by ID, and have attributes:

>>> heldmsg = test_one.get_held_message(1)
>>> print(heldmsg.subject)
Something
>>> print(heldmsg.reason)
The message is not from a list member
>>> print(heldmsg.sender)
nomember@example.com
>>> 'Message-ID: <moderated_01>' in heldmsg.msg
True

A moderation action can be taken on them using the list methods or the held message’s methods.

>>> print(test_one.defer_message(heldmsg.request_id)['status'])
204

>>> len(test_one.held)
1

>>> print(heldmsg.discard()['status'])
204

>>> len(test_one.held)
0

Member moderation¶

Each member or non-member can have a specific moderation action. It is set using the ‘moderation_action’ property:

>>> bill_member = test_one.get_member('bill@example.com')
>>> print(bill_member.moderation_action)
None
>>> bill_member.moderation_action = 'hold'
>>> bill_member.save()
>>> print(test_one.get_member('bill@example.com').moderation_action)
hold

Banning addresses¶

A ban list is a list of email addresses that are not allowed to subscribe to a mailing-list. There are two types of ban lists: each mailing-list has its ban list, and there is a site-wide list. Addresses on the site-wide list are prevented from subscribing to every mailing-list on the server.

To view the site-wide ban list, use the bans property:

>>> list(client.bans)
[]

You can use the add method on the ban list to ban an email address:

>>> banned_anna = client.bans.add('anna@example.com')
>>> print(banned_anna)
anna@example.com
>>> 'anna@example.com' in client.bans
True
>>> client.bans.add('bill@example.com')
bill@example.com
>>> print(list(client.bans))
[anna@example.com, bill@example.com]

The list of banned addresses can be paginated using the get_bans_page() method:

>>> print(list(client.get_bans_page(count=1, page=1)))
[anna@example.com]
>>> print(list(client.get_bans_page(count=1, page=2)))
[bill@example.com]

You can use the delete() method on a banned address to unban it, or the remove() method on the ban list:

>>> banned_anna.delete()
>>> 'anna@example.com' in client.bans
False
>>> print(list(client.bans))
[bill@example.com]
>>> client.bans.remove('bill@example.com')
>>> 'bill@example.com' in client.bans
False
>>> print(list(client.bans))
[]

The mailing-list-specific ban lists work in the same way:

>>> print(list(test_one.bans))
[]
>>> banned_anna = test_one.bans.add('anna@example.com')
>>> 'anna@example.com' in test_one.bans
True
>>> test_one.bans.add('bill@example.com')
bill@example.com
>>> print(list(test_one.bans))
[anna@example.com, bill@example.com]
>>> print(list(test_one.get_bans_page(count=1, page=1)))
[anna@example.com]
>>> print(list(test_one.get_bans_page(count=1, page=2)))
[bill@example.com]
>>> banned_anna.delete()
>>> 'anna@example.com' in test_one.bans
False
>>> test_one.bans.remove('bill@example.com')
>>> print(list(test_one.bans))
[]

Archivers¶

Each list object has an archivers attribute.

>>> archivers = test_one.archivers
>>> print(archivers)
<Archivers on "test-1.example.com">

The activation status of each available archiver can be accessed like a key in a dictionary.

>>> archivers = test_one.archivers
>>> for archiver in sorted(archivers.keys()):
...     print('{0}: {1}'.format(archiver, archivers[archiver]))
mail-archive: True
mhonarc: True
prototype: True

>>> archivers['mail-archive']
True
>>> archivers['mhonarc']
True

They can also be set like items in dictionary.

>>> archivers['mail-archive'] = False
>>> archivers['mhonarc'] = False

So if we get a new archivers object from the API (by accessing the list’s archiver attribute again), we can see that the archiver stati have now been set.

>>> archivers = test_one.archivers
>>> archivers['mail-archive']
False
>>> archivers['mhonarc']
False

Header matches¶

Header matches are filtering rules that apply to messages sent to a mailing list. They match a header to a pattern using a regular expression, and matching patterns can trigger specific moderation actions. They are accessible via the mailing list’s header_matches attribute, which behaves like a list.

>>> header_matches = test_one.header_matches
>>> print(header_matches)
<HeaderMatches for "test-1.example.com">
>>> len(header_matches)
0

Header matches can be added using the add() method. The arguments are:

the header to consider (str). Il will be lower-cased.
the regular expression to use for filtering (str)

the action to take when the header matches the pattern. This can be 'accept', 'discard', 'reject', or 'hold'.

>>> header_matches.add('Subject', '^test: ', 'discard')
<HeaderMatch on "subject">
>>> print(header_matches)
<HeaderMatches for "test-1.example.com">
>>> len(header_matches)
1
>>> print(list(header_matches))
[<HeaderMatch on "subject">]

You can delete a header match by deleting it from the header_matches collection.

>>> del header_matches[0]
>>> len(header_matches)
0

You can also delete a header match using its delete() method, but be aware that the collection will not automatically be updated. Get a new collection from the list’s header_matches attribute to see the change.

>>> header_matches.add('Subject', '^test: ', 'discard')
<HeaderMatch on "subject">
>>> header_matches[0].delete()
>>> len(header_matches) # not automatically updated
1
>>> len(test_one.header_matches)
0

Configuration¶

Mailman Core exposes all its configuration through REST API. All these configuration options are read-only.

>>> cfg = client.configuration
>>> for key in sorted(cfg):
...     print(cfg[key])
<Configuration: "antispam">
<Configuration: "archiver.mail_archive">
<Configuration: "archiver.master">
<Configuration: "archiver.mhonarc">
<Configuration: "archiver.prototype">
<Configuration: "bounces">
<Configuration: "database">
<Configuration: "devmode">
<Configuration: "digests">
<Configuration: "dmarc">
<Configuration: "language.ar">
<Configuration: "language.ast">
<Configuration: "language.ca">
<Configuration: "language.cs">
<Configuration: "language.da">
<Configuration: "language.de">
<Configuration: "language.el">
<Configuration: "language.en">
<Configuration: "language.es">
<Configuration: "language.et">
<Configuration: "language.eu">
<Configuration: "language.fi">
<Configuration: "language.fr">
<Configuration: "language.gl">
<Configuration: "language.he">
<Configuration: "language.hr">
<Configuration: "language.hu">
<Configuration: "language.ia">
<Configuration: "language.it">
<Configuration: "language.ja">
<Configuration: "language.ko">
<Configuration: "language.lt">
<Configuration: "language.nl">
<Configuration: "language.no">
<Configuration: "language.pl">
<Configuration: "language.pt">
<Configuration: "language.pt_BR">
<Configuration: "language.ro">
<Configuration: "language.ru">
<Configuration: "language.sk">
<Configuration: "language.sl">
<Configuration: "language.sr">
<Configuration: "language.sv">
<Configuration: "language.tr">
<Configuration: "language.uk">
<Configuration: "language.vi">
<Configuration: "language.zh_CN">
<Configuration: "language.zh_TW">
<Configuration: "logging.archiver">
<Configuration: "logging.bounce">
<Configuration: "logging.config">
<Configuration: "logging.database">
<Configuration: "logging.debug">
<Configuration: "logging.error">
<Configuration: "logging.fromusenet">
<Configuration: "logging.http">
<Configuration: "logging.locks">
<Configuration: "logging.mischief">
<Configuration: "logging.root">
<Configuration: "logging.runner">
<Configuration: "logging.smtp">
<Configuration: "logging.subscribe">
<Configuration: "logging.vette">
<Configuration: "mailman">
<Configuration: "mta">
<Configuration: "nntp">
<Configuration: "passwords">
<Configuration: "paths.dev">
<Configuration: "paths.fhs">
<Configuration: "paths.here">
<Configuration: "paths.local">
<Configuration: "runner.archive">
<Configuration: "runner.bad">
<Configuration: "runner.bounces">
<Configuration: "runner.command">
<Configuration: "runner.digest">
<Configuration: "runner.in">
<Configuration: "runner.lmtp">
<Configuration: "runner.nntp">
<Configuration: "runner.out">
<Configuration: "runner.pipeline">
<Configuration: "runner.rest">
<Configuration: "runner.retry">
<Configuration: "runner.shunt">
<Configuration: "runner.virgin">
<Configuration: "shell">
<Configuration: "styles">
<Configuration: "webservice">

Each configuration object is a dictionary and you can iterate over them:

>>> for key in sorted(cfg['mailman']):
...     print('{} : {}'.format(key, cfg['mailman'][key]))
cache_life : 7d
default_language : en
email_commands_max_lines : 10
filtered_messages_are_preservable : no
html_to_plain_text_command : /usr/bin/lynx -dump $filename
layout : here
listname_chars : [-_.0-9a-z]
noreply_address : noreply
pending_request_life : 3d
post_hook :
pre_hook :
self_link : http://localhost:9001/3.1/system/configuration/mailman
sender_headers : from from_ reply-to sender
site_owner : changeme@example.com

API Reference¶

class mailmanclient.Client(baseurl, name=None, password=None)¶

Access the Mailman REST API root.

bans¶

chains¶

configuration¶

create_domain(mail_host, base_url=<object object>, description=None, owner=None)¶

create_user(email, password, display_name=u'')¶

delete_domain(mail_host)¶

delete_list(fqdn_listname)¶

domains¶

get_address(address)¶

get_bans_page(count=50, page=1)¶

get_domain(mail_host, web_host=<object object>)¶: Get domain by its mail_host or its web_host.

get_list(fqdn_listname)¶

get_list_page(count=50, page=1, advertised=None)¶

get_lists(advertised=None)¶

get_member(fqdn_listname, subscriber_address)¶

get_member_page(count=50, page=1)¶

get_user(address)¶

get_user_page(count=50, page=1)¶

lists¶

members¶

pipelines¶

preferences¶

queues¶

system¶

users¶

class mailmanclient._client.MailingList(connection, url, data=None)¶

accept_message(request_id)¶: Shortcut for moderate_message.

accept_request(request_id)¶: Shortcut to accept a subscription request.

add_moderator(address)¶

add_owner(address)¶

add_role(role, address)¶

archivers¶

bans¶

defer_message(request_id)¶: Shortcut for moderate_message.

defer_request(request_id)¶: Shortcut to defer a subscription request.

discard_message(request_id)¶: Shortcut for moderate_message.

discard_request(request_id)¶: Shortcut to discard a subscription request.

find_members(address, role='member', page=None, count=50)¶

get_bans_page(count=50, page=1)¶

get_held_message(held_id)¶

get_held_page(count=50, page=1)¶

get_member(email)¶

Get a membership.

Parameters:	address – The email address of the member for this list.
Returns:	A member proxy object.

get_member_page(count=50, page=1)¶

header_matches¶

held¶: Return a list of dicts with held message information.

manage_request(token, action)¶: Alias for moderate_request, kept for compatibility

members¶

moderate_message(request_id, action)¶

Moderate a held message.

Parameters:	request_id (Int.) – Id of the held message. action (String.) – Action to perform on held message.

moderate_request(request_id, action)¶

Moderate a subscription request.

Parameters:	action (str.) – accept\|reject\|discard\|defer

moderators¶

nonmembers¶

owners¶

reject_message(request_id)¶: Shortcut for moderate_message.

reject_request(request_id)¶: Shortcut to reject a subscription request.

remove_moderator(address)¶

remove_owner(address)¶

remove_role(role, address)¶

requests¶: Return a list of dicts with subscription requests.

settings¶

subscribe(address, display_name=None, pre_verified=False, pre_confirmed=False, pre_approved=False)¶

Subscribe an email address to a mailing list.

Parameters:	address (str) – Email address to subscribe to the list. display_name (str) – The real name of the new member. pre_verified (bool) – True if the address has been verified. pre_confirmed (bool) – True if membership has been approved by the user. pre_approved (bool) – True if membership is moderator-approved.
Returns:	A member proxy object.

unsubscribe(email)¶

Unsubscribe an email address from a mailing list.

Parameters:	address – The address to unsubscribe.

class mailmanclient._client.ListArchivers(connection, url, mlist)¶: Represents the activation status for each site-wide available archiver for a given list.

class mailmanclient._client.Bans(connection, url, data=None, mlist=None)¶

The list of banned addresses from a mailing-list or from the whole site.

add(email)¶

find_by_email(email)¶

remove(email)¶

class mailmanclient._client.BannedAddress(connection, url, data=None)¶

mailinglist¶

class mailmanclient._client.HeaderMatches(connection, url, mlist)¶

The list of header matches for a mailing-list.

add(header, pattern, action=None)¶

Parameters:	header (str) – The header to consider. pattern (str) – The regular expression to use for filtering. action (str) – The action to take when the header matches the pattern. This can be ‘accept’, ‘discard’, ‘reject’, or ‘hold’.

class mailmanclient._client.HeaderMatch(connection, url, data=None)¶

class mailmanclient._client.Member(connection, url, data=None)¶

address¶

unsubscribe()¶: Unsubscribe the member from a mailing list.

user¶

class mailmanclient._client.User(connection, url, data=None)¶

add_address(email, absorb_existing=False)¶

Adds another email adress to the user record and returns an _Address object.

Parameters:	email (str.) – The address to add absorb_existing (bool.) – set this to True if you want to add the address even if it already exists. It will import the existing user into the current one, not overwriting any previously set value.

addresses¶

subscription_list_ids¶

subscriptions¶

class mailmanclient._client.Addresses(connection, url, data=None)¶

find_by_email(email)¶

remove(email)¶

class mailmanclient._client.Address(connection, url, data=None)¶

unverify()¶

user¶

verified¶

verify()¶

class mailmanclient._client.HeldMessage(connection, url, data=None)¶

accept()¶: Shortcut for moderate.

defer()¶: Shortcut for moderate.

discard()¶: Shortcut for moderate.

moderate(action)¶

Moderate a held message.

Parameters:	action (String.) – Action to perform on held message.

reject()¶: Shortcut for moderate.

class mailmanclient._client.Preferences(connection, url, data=None)¶

delete()¶

class mailmanclient._client.Settings(connection, url, data=None)¶

class mailmanclient._client.Queue(connection, url, data=None)¶

files¶

inject(list_id, text)¶

Developing MailmanClient¶

Running Tests¶

The test suite is run with the tox tool, which allows it to be run against multiple versions of Python. There are two modes to the test suite:

Record mode which is used to record the HTTP traffic against a live Mailman 3 REST server.

Replay mode which allows you to run the test suite off-line, without running the REST server.

Whenever you add tests for other parts of the REST API, you need to run the suite once in record mode to generate the YAML file of HTTP requests and responses.

Then you can run the test suite in replay mode as often as you want, and Mailman 3 needn’t even be installed on your system.

Since this branch ships with a recording file, you don’t need to run in record mode to start with.

Replay mode¶

To run the test suite in replay mode (the default), just run the following:

$ tox

This will attempt to run the test suite against Python 2.7, 3.4, 3.5 and 3.6 or whatever combination of those that are available on your system.

Record mode¶

Start by branching the Mailman 3 code base, then you should install it into a virtual environment. The easiest way to do this is with tox:

$ tox --notest -r

Now, use the virtual environment that tox creates to create a template var directory in the current directory:

$ .tox/py34/bin/mailman info

Now you need to modify the var/etc/mailman.cfg configuration file, so that it contains the following:

[devmode]
enabled: yes
testing: yes
recipient: you@yourdomain.com

[mta]
smtp_port: 9025
lmtp_port: 9024
incoming: mailman.testing.mta.FakeMTA

[webservice]
port: 9001

[archiver.mhonarc]
enable: yes

[archiver.mail_archive]
enable: yes

[archiver.prototype]
enable: yes

Now you can start Mailman 3:

$ .tox/py34/bin/mailman start

Back in your mailmanclient branch, run the test suite in record mode:

$ tox -e record

You should now have an updated recording file (tape.yaml).

If you find you need to re-run the test suite, you must first stop the Mailman REST server, and then delete the mailman.db file, since it contains state that will mess up the mailmanclient test suite:

$ cd <mailman3-branch>
$ .tox/py34/bin/mailman stop
$ rm -f var/data/mailman.db
$ .tox/py34/bin/mailman start

$ cd <mailmanclient-branch>
$ tox -e record

Once you’re done recording the HTTP traffic, you can stop the Mailman 3 server and you won’t need it again. It’s a good idea to commit the tape.yaml changes for other users of your branch.