um-flint/mailman-api

A PHP package to manage users in mailman.

GNU Mailman API

Note: This API is incomplete. There are several things in the Mailman documentation that have not been implemented just because that were not needed., _(*1)

If you would like to contribute to this API, submit a pull request to have your changes reviewed before they are merged into master., _(*2)

Table of Contents

• Methods
  • Mailman
  • Users
  • Lists
  • Members
  • Domains

Methods

Mailman

• domains() : Domains
• lists() : Lists
• users() : Users
• members() : Members

Example to get all lists:, _(*3)

$allLists = $mailman->lists()->all(null, null, true);

Example to get lists for a user:, _(*4)

$usersLists = $mailman->members()->find(null, 'email_address');

Users

• all($count = null, $page = null)
• find($email)
• create($email, $displayName = null, $password = null)
• updateDisplayName($email, $displayName)
• updatePassword($email, $password)
• delete($email)

Lists

• all($count = null, $page = null, $advertised = null)
• find($name)
• members($name, $count = null, $page = null)
• create($name, $style = null)
• delete($domain)

Members

• all($count = null, $page = null)
• find($listId = null, $subscriber = null, $role = null)
• subscribe($listId, $subscriber, $displayName = null, $verified = false, $confirmed = false, $approved = false)
• unsubscribe($memberId)

Domains

• all($count, $page)
• find($domain)
• lists($domain, $count = null, $page = null, $advertised = null)
• create($domain, $description = null)
• delete($domain)