class documentation
class AsyncClient: (source)
Provide an Idiomatic API for Mailman Core.
It requires an HTTP client instance as the first argument. You can use any client which has a .request() method and accepts named parameters url, path, auth, method and data. data is supposed to be a dictionary of parameters to be passed to the HTTP request and the rest are string parameters with their usual meaning.
The parameters are based off on httpx python library.
Parameters | |
client | Http client object with an async request method. |
base | Base URL to Core's API. |
user | Core admin username. |
password | Core admin password. |
Method | __init__ |
Undocumented |
Async Method | addresses |
All the addresses in Mailman |
Async Method | domains |
Get all domains. |
Async Method | find |
Find members. |
Async Method | lists |
Get a list of MailingLists |
Async Method | members |
All the Members |
Async Method | system |
Get the Mailman system information. |
Async Method | users |
All the users in Mailman Core |
Instance Variable | client |
Undocumented |
Instance Variable | connection |
Undocumented |
Undocumented
Parameters | |
client:HTTPClientProto | Undocumented |
basestr | Undocumented |
user:str | Undocumented |
password:str | Undocumented |
async def find_members(self, list_id=None, subscriber=None, role=None, moderation_action=None, delivery_status=None, delivery_mode=None):
(source)
¶
Find members.
/<api>/members/find
Parameters | |
liststr | Mailinglist id. |
subscriber:str | Email or user_id or partial search string. |
role:str | Membership role. One of 'owner', 'member', 'nonmember' or 'moderator'. |
moderationstr | One of the moderation action from 'defer', 'accept', 'discard', 'reject', 'hold'. |
deliverystr | Delivery status of the Member. It can be one among 'enabled', 'by_user', 'by_moderator' or 'by_bounces'. |
deliverystr | Delivery mode of the member. It can be one between 'plaintext_digests', 'mime_digests', 'regular'. |
Returns | |
List[ | Undocumented |