API Reference¶
-
class
mailmanclient.
Client
(baseurl, name=None, password=None)[source]¶ Access the Mailman REST API root.
-
bans
¶
-
chains
¶
-
configuration
¶
-
domains
¶
-
get_domain
(mail_host, web_host=<object object>)[source]¶ Get domain by its mail_host or its web_host.
-
lists
¶
-
members
¶
-
pipelines
¶
-
preferences
¶
-
queues
¶
-
system
¶
-
users
¶
-
-
class
mailmanclient._client.
Domain
(connection, url, data=None)[source]¶ -
-
base_url
¶
-
lists
¶
-
owners
¶
-
web_host
¶
-
-
class
mailmanclient._client.
MailingList
(connection, url, data=None)[source]¶ -
-
archivers
¶
-
bans
¶
-
get_member
(email)[source]¶ Get a membership.
Parameters: address – The email address of the member for this list. Returns: A member proxy object.
-
header_matches
¶
-
held
¶ Return a list of dicts with held message information.
-
members
¶
-
moderate_message
(request_id, action)[source]¶ 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)[source]¶ Moderate a subscription request.
Parameters: action (str.) – accept|reject|discard|defer
-
moderators
¶
-
nonmembers
¶
-
owners
¶
-
requests
¶ Return a list of dicts with subscription requests.
-
settings
¶
-
subscribe
(address, display_name=None, pre_verified=False, pre_confirmed=False, pre_approved=False)[source]¶ 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.
-
-
class
mailmanclient._client.
ListArchivers
(connection, url, mlist)[source]¶ Represents the activation status for each site-wide available archiver for a given list.
-
class
mailmanclient._client.
Bans
(connection, url, data=None, mlist=None)[source]¶ The list of banned addresses from a mailing-list or from the whole site.
-
class
mailmanclient._client.
HeaderMatches
(connection, url, mlist)[source]¶ The list of header matches for a mailing-list.
-
class
mailmanclient._client.
User
(connection, url, data=None)[source]¶ -
add_address
(email, absorb_existing=False)[source]¶ 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
¶
-