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

Module Index

  • mailmanclient - Package contents.
    • _client - Old module for backwards compatibility
    • asynclient - Async client for Mailman Core 3.1 API.
    • asyncobjects - No package docstring; 6/6 modules documented
      • address - Address async object.
      • domain - Async domain object.
      • mailinglist - Async Mailinglist object..
      • member - Member async object.
      • preferences - Preferences object and mixins.
      • user - User async object.
    • client - Client code.
    • conftest - Testing utilities.
    • constants - Undocumented
    • restbase - No package docstring; 2/5 modules documented
      • async_base - Base classes for async objects.
      • async_connection - Async connection object.
      • base - No module docstring; 4/4 classes documented
      • connection - No module docstring; 2/2 classes documented
      • page - Undocumented
    • restobjects - No package docstring; 2/17 modules documented
      • address - Undocumented
      • archivers - No module docstring; 1/1 class documented
      • ban - No module docstring; 1/2 class documented
      • configuration - Undocumented
      • domain - Undocumented
      • header_match - No module docstring; 1/2 class documented
      • held_message - Undocumented
      • mailinglist - Undocumented
      • member - Undocumented
      • preferences - No module docstring; 1/2 class documented
      • queue - Undocumented
      • settings - Undocumented
      • styles - Undocumented
      • templates - Template objects.
      • types - No module docstring; 0/1 variable, 2/3 classes documented
      • user - Undocumented
      • utils - Some async method utilities.
    • testing - No package docstring; 2/2 modules documented
      • documentation - Harness for testing Mailman's documentation.
      • vcr_helpers - Helpers for VCR
API Documentation for mailmanclient, generated by pydoctor 22.4.0 at 2022-04-18 02:49:48.