src/mailman/app/docs/lifecycle.rst

   1 =================================
   2 Application level list life cycle
   3 =================================
   4
   5 The low-level way to create and delete a mailing list is to use the
   6 ``IListManager`` interface.  This interface simply adds or removes the
   7 appropriate database entries to record the list's creation.
   8
   9 There is a higher level interface for creating and deleting mailing lists
  10 which performs additional tasks such as:
  11
  12  * validating the list's posting address (which also serves as the list's
  13    fully qualified name);
  14  * ensuring that the list's domain is registered;
  15  * :ref:`applying a list style <list-creation-styles>` to the new list;
  16  * creating and assigning list owners;
  17  * notifying watchers of list creation;
  18  * creating ancillary artifacts (such as the list's on-disk directory)
  19
  20
  21 Creating a list with owners
  22 ===========================
  23
  24 You can also specify a list of owner email addresses.  If these addresses are
  25 not yet known, they will be registered, and new users will be linked to them.
  26 ::
  27
  28     >>> owners = [
  29     ...     'aperson@example.com',
  30     ...     'bperson@example.com',
  31     ...     'cperson@example.com',
  32     ...     'dperson@example.com',
  33     ...     ]
  34
  35     >>> ant = create_list('ant@example.com', owners)
  36     >>> dump_list(address.email for address in ant.owners.addresses)
  37     aperson@example.com
  38     bperson@example.com
  39     cperson@example.com
  40     dperson@example.com
  41
  42 None of the owner addresses are verified.
  43
  44     >>> any(address.verified_on is not None
  45     ...     for address in ant.owners.addresses)
  46     False
  47
  48 However, all addresses are linked to users.
  49
  50     >>> from mailman.interfaces.usermanager import IUserManager
  51     >>> from zope.component import getUtility
  52     >>> user_manager = getUtility(IUserManager)
  53     >>> for address in owners:
  54     ...     user = user_manager.get_user(address)
  55     ...     print(int(user.user_id.int), list(user.addresses)[0])
  56     1 aperson@example.com
  57     2 bperson@example.com
  58     3 cperson@example.com
  59     4 dperson@example.com
  60
  61 If you create a mailing list with owner addresses that are already known to
  62 the system, they won't be created again.
  63
  64     >>> bee = create_list('bee@example.com', owners)
  65     >>> from operator import attrgetter
  66     >>> for user in sorted(bee.owners.users, key=attrgetter('user_id')):
  67     ...     print(int(user.user_id.int), list(user.addresses)[0])
  68     1 aperson@example.com
  69     2 bperson@example.com
  70     3 cperson@example.com
  71     4 dperson@example.com
  72
  73
  74 Deleting a list
  75 ===============
  76
  77 Removing a mailing list deletes the list, all its subscribers, and any related
  78 artifacts.
  79 ::
  80
  81     >>> from mailman.app.lifecycle import remove_list
  82     >>> remove_list(bee)
  83
  84     >>> from mailman.interfaces.listmanager import IListManager
  85     >>> print(getUtility(IListManager).get('bee@example.com'))
  86     None
  87
  88 We should now be able to completely recreate the mailing list.
  89
  90     >>> buzz = create_list('bee@example.com', owners)
  91     >>> dump_list(address.email for address in bee.owners.addresses)
  92     aperson@example.com
  93     bperson@example.com
  94     cperson@example.com
  95     dperson@example.com