mailmanclient API Documentation Modules Classes Names
Clear Help

Search bar offers the following options:

  • Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: +foo bar -baz
  • Wildcards. The below example searches for documents with words beginning with “foo”: foo*
  • Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: +qname:twisted.mail.* +search

    Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

  • Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: foo~1

Results provided by Lunr.js

Class Hierarchy

  • collections.abc.MutableMapping
    • mailmanclient.restbase.base.RESTDict - Base class for REST data that behaves like a dictionary.
      • mailmanclient.restobjects.archivers.ListArchivers - Represents the activation status for each site-wide available archiver for a given list.
      • mailmanclient.restobjects.configuration.Configuration - Undocumented
      • mailmanclient.restobjects.preferences.Preferences - Undocumented
      • mailmanclient.restobjects.settings.Settings - Undocumented
      • mailmanclient.restobjects.styles.Styles - Undocumented
  • collections.abc.Sequence
    • mailmanclient.restbase.base.RESTList - Base class for REST data that behaves like a list.
      • mailmanclient.restobjects.address.Addresses - Undocumented
      • mailmanclient.restobjects.ban.Bans - The list of banned addresses from a mailing-list or from the whole site.
      • mailmanclient.restobjects.header_match.HeaderMatches - The list of header matches for a mailing-list.
      • mailmanclient.restobjects.templates.TemplateList - Undocumented
  • enum.Enum
    • mailmanclient.asyncobjects.mailinglist.MemberRole - Member role values.
  • Exception
    • mailmanclient.restbase.connection.MailmanConnectionError - Custom Exception to catch connection errors.
  • mailmanclient.asynclient.AsyncClient - Provide an Idiomatic API for Mailman Core.
  • mailmanclient.asyncobjects.preferences.PreferencesMixin - Mixin for restobjects that have preferences.
    • mailmanclient.asyncobjects.address.Address - Undocumented
    • mailmanclient.asyncobjects.member.Member - Undocumented
    • mailmanclient.asyncobjects.user.User - Undocumented
  • mailmanclient.client.Client - Access the Mailman REST API root.
  • mailmanclient.restbase.async_base.RESTBase - No class docstring; 0/3 instance variable, 0/3 class variable, 3/6 methods documented
    • mailmanclient.restbase.async_base.RESTObject - Undocumented
      • mailmanclient.asyncobjects.address.Address - Undocumented
      • mailmanclient.asyncobjects.domain.Domain - Undocumented
      • mailmanclient.asyncobjects.mailinglist.Config - Undocumented
      • mailmanclient.asyncobjects.mailinglist.MailingList - No class docstring; 0/1 class variable, 6/7 methods documented
      • mailmanclient.asyncobjects.member.Member - Undocumented
      • mailmanclient.asyncobjects.preferences.Preferences - Undocumented
      • mailmanclient.asyncobjects.user.User - Undocumented
  • mailmanclient.restbase.base.RESTBase - Base class for data coming from the REST API.
    • mailmanclient.restbase.base.RESTDict - Base class for REST data that behaves like a dictionary.
      • mailmanclient.restobjects.archivers.ListArchivers - Represents the activation status for each site-wide available archiver for a given list.
      • mailmanclient.restobjects.configuration.Configuration - Undocumented
      • mailmanclient.restobjects.preferences.Preferences - Undocumented
      • mailmanclient.restobjects.settings.Settings - Undocumented
      • mailmanclient.restobjects.styles.Styles - Undocumented
    • mailmanclient.restbase.base.RESTList - Base class for REST data that behaves like a list.
      • mailmanclient.restobjects.address.Addresses - Undocumented
      • mailmanclient.restobjects.ban.Bans - The list of banned addresses from a mailing-list or from the whole site.
      • mailmanclient.restobjects.header_match.HeaderMatches - The list of header matches for a mailing-list.
      • mailmanclient.restobjects.templates.TemplateList - Undocumented
    • mailmanclient.restbase.base.RESTObject - Base class for REST data that behaves like an object with attributes.
      • mailmanclient.restobjects.address.Address - Undocumented
      • mailmanclient.restobjects.ban.BannedAddress - Undocumented
      • mailmanclient.restobjects.domain.Domain - Undocumented
      • mailmanclient.restobjects.header_match.HeaderMatch - Undocumented
      • mailmanclient.restobjects.held_message.HeldMessage - No class docstring; 0/1 class variable, 5/6 methods documented
      • mailmanclient.restobjects.mailinglist.MailingList - No class docstring; 12/12 properties, 0/1 instance variable, 0/1 class variable, 39/42 methods documented
      • mailmanclient.restobjects.member.Member - No class docstring; 0/2 property, 0/2 class variable, 1/3 method documented
      • mailmanclient.restobjects.queue.Queue - Undocumented
      • mailmanclient.restobjects.templates.Template - Undocumented
      • mailmanclient.restobjects.user.User - No class docstring; 1/4 property, 0/3 instance variable, 0/2 class variable, 3/5 methods documented
  • mailmanclient.restbase.connection.Connection - A connection to the REST client.
    • mailmanclient.restbase.async_connection.Connection - A standard Connection object.
  • mailmanclient.restbase.page.Page - Undocumented
  • mailmanclient.restobjects.preferences.PreferencesMixin - Mixin for restobjects that have preferences.
    • mailmanclient.restobjects.address.Address - Undocumented
    • mailmanclient.restobjects.member.Member - No class docstring; 0/2 property, 0/2 class variable, 1/3 method documented
    • mailmanclient.restobjects.user.User - No class docstring; 1/4 property, 0/3 instance variable, 0/2 class variable, 3/5 methods documented
  • mailmanclient.testing.vcr_helpers.vcr_testcase - Decorator for TestCases that use VCR. It automatically sets up a different cassette for each test function.
  • typing.Protocol
    • mailmanclient.restobjects.types.ConnectionProto - A type checking procol for connection object to avoid circular import
    • mailmanclient.restobjects.types.HTTPClientProto - A type checking protocol for the HTTP client argument for AsyncClient
    • mailmanclient.restobjects.types.ResponseType - Undocumented
API Documentation for mailmanclient, generated by pydoctor 22.4.0 at 2022-04-18 02:49:48.