← Back to branch summary

~andrea-crotti-0/mailman/readthedocs

« back to all changes in this revision

Viewing changes to src/mailman/interfaces/mailinglist.py

  • Committer: Barry Warsaw
  • Date: 2012-03-04 23:39:08 UTC
  • Revision ID: barry@list.org-20120304233908-upzd5p38b8rbh3gl
Template indirection now also in effect for regular and digest headers and
footers, using the same semantics and algorithm as for welcome and goodbye
messages.

Additional schema changes:

   - msg_header       -> header_uri
   - msg_footer       -> footer_uri
   - digest_header    -> digest_header_uri
   - digest_footer    -> digest_footer_uri

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/mailman/interfaces/mailinglist.py
306
306
        digest recipients are cleared.
307
307
        """)
308
308
 
309
 
    decorators = Attribute(
310
 
        """An iterator over all the IDecorators associated with this digest.
311
 
        When a digest is being sent, each decorator may modify the final
312
 
        digest text.""")
313
 
 
314
309
    # Web access.
315
310
 
316
311
    scheme = Attribute(
334
329
        'location' attribute.
335
330
        """
336
331
 
337
 
    # Notifications.
338
 
 
339
 
    admin_immed_notify = Attribute(
340
 
        """Flag controlling immediate notification of requests.
341
 
 
342
 
        List moderators normally get daily notices about pending
343
 
        administrative requests.  This flag controls whether moderators also
344
 
        receive immediate notification of such pending requests.
345
 
        """)
346
 
 
347
 
    admin_notify_mchanges = Attribute(
348
 
        """Flag controlling notification of joins and leaves.
349
 
 
350
 
        List moderators can receive notifications for every member that joins
351
 
        or leaves their mailing lists.  This flag controls those
352
 
        notifications.
353
 
        """)
354
 
 
355
332
    # Autoresponses.
356
333
 
357
334
    autoresponse_grace_period = Attribute(
518
495
 
519
496
    # Notifications.
520
497
 
 
498
    admin_immed_notify = Attribute(
 
499
        """Flag controlling immediate notification of requests.
 
500
 
 
501
        List moderators normally get daily notices about pending
 
502
        administrative requests.  This flag controls whether moderators also
 
503
        receive immediate notification of such pending requests.
 
504
        """)
 
505
 
 
506
    admin_notify_mchanges = Attribute(
 
507
        """Flag controlling notification of joins and leaves.
 
508
 
 
509
        List moderators can receive notifications for every member that joins
 
510
        or leaves their mailing lists.  This flag controls those
 
511
        notifications.
 
512
        """)
 
513
 
521
514
    send_welcome_message = Attribute(
522
515
        """Flag indicating whether a welcome message should be sent.""")
523
516
 
524
517
    welcome_message_uri = Attribute(
525
518
        """URI for the list's welcome message.
526
519
 
527
 
        This can be any URI supported by `httplib2` with the addition of
 
520
        This can be any URI supported by `urllib2` with the addition of
528
521
        `mailman:` URIs, which reference internal default resources.  This is
529
522
        a template which can include the following placeholders:
530
523
 
551
544
    goodbye_message_uri = Attribute(
552
545
        """URI for the list's goodbye message.
553
546
 
554
 
        This can be any URI supported by `httplib2` with the addition of
 
547
        This can be any URI supported by `urllib2` with the addition of
555
548
        `mailman:` URIs, which reference internal default resources.  This is
556
549
        a template which can include the following placeholders:
557
550
 
558
551
        $listname - the FQDN list name for this mailing list.
559
552
        $language - the language code, usually the list's preferred language.
560
553
 
561
 
        The resource will be downloaded and cached whenever the welcome
 
554
        The resource will be downloaded and cached whenever the goodbye
562
555
        message is sent.  The resource at this URI can contain the following
563
556
        placeholders, which are also filled in through values on the mailing
564
557
        list:
572
565
        $user_options_uri - the URI to this member's options page.
573
566
        """)
574
567
 
 
568
    # Decorators.
 
569
 
 
570
    header_uri = Attribute(
 
571
        """URI for the header decorator on regular delivery messages.
 
572
 
 
573
        This can be any URI supported by `urllib2` with the addition of
 
574
        `mailman:` URIs, which reference internal default resources.  This is
 
575
        a template which can include the following placeholders:
 
576
 
 
577
        $listname - the FQDN list name for this mailing list.
 
578
        $language - the language code, usually the list's preferred language.
 
579
 
 
580
        The resource will be downloaded and cached whenever the decorator is
 
581
        needed.  The resource at this URI can contain the following
 
582
        placeholders, which are also filled in through values on the mailing
 
583
        list:
 
584
 
 
585
        $fqdn_listname    - the FQDN list name for this mailing list.
 
586
        $list_name        - the human readable name for the mailing list.
 
587
        $host_name        - the mailing list's host name
 
588
        $listinfo_uri     - the URI to the list's information page.
 
589
        $list_requests    - the address to the list's `-request` address.
 
590
        $description      - the mailing list's description
 
591
        $info             - additional mailing list's information
 
592
 
 
593
        Personalized messages will also have these placeholders available:
 
594
 
 
595
        $user_name        - the name of the subscribing user.
 
596
        $user_address     - the email address of the subscribing user.
 
597
        $user_options_uri - the URI to this member's options page.
 
598
        """
 
599
        )
 
600
 
 
601
    footer_uri = Attribute(
 
602
        """URI for the footer decorator on regular delivery messages.
 
603
 
 
604
        This can be any URI supported by `urllib2` with the addition of
 
605
        `mailman:` URIs, which reference internal default resources.  This is
 
606
        a template which can include the following placeholders:
 
607
 
 
608
        $listname - the FQDN list name for this mailing list.
 
609
        $language - the language code, usually the list's preferred language.
 
610
 
 
611
        The resource will be downloaded and cached whenever the decorator is
 
612
        needed.  The resource at this URI can contain the following
 
613
        placeholders, which are also filled in through values on the mailing
 
614
        list:
 
615
 
 
616
        $fqdn_listname    - the FQDN list name for this mailing list.
 
617
        $list_name        - the human readable name for the mailing list.
 
618
        $host_name        - the mailing list's host name
 
619
        $listinfo_uri     - the URI to the list's information page.
 
620
        $list_requests    - the address to the list's `-request` address.
 
621
        $description      - the mailing list's description
 
622
        $info             - additional mailing list's information
 
623
 
 
624
        Personalized messages will also have these placeholders available:
 
625
 
 
626
        $user_name        - the name of the subscribing user.
 
627
        $user_address     - the email address of the subscribing user.
 
628
        $user_options_uri - the URI to this member's options page.
 
629
        """
 
630
        )
 
631
 
 
632
    digest_header_uri = Attribute(
 
633
        """URI for the header decorator on digest messages.
 
634
 
 
635
        This can be any URI supported by `urllib2` with the addition of
 
636
        `mailman:` URIs, which reference internal default resources.  This is
 
637
        a template which can include the following placeholders:
 
638
 
 
639
        $listname - the FQDN list name for this mailing list.
 
640
        $language - the language code, usually the list's preferred language.
 
641
 
 
642
        The resource will be downloaded and cached whenever the decorator is
 
643
        needed.  The resource at this URI can contain the following
 
644
        placeholders, which are also filled in through values on the mailing
 
645
        list:
 
646
 
 
647
        $fqdn_listname    - the FQDN list name for this mailing list.
 
648
        $list_name        - the human readable name for the mailing list.
 
649
        $host_name        - the mailing list's host name
 
650
        $listinfo_uri     - the URI to the list's information page.
 
651
        $list_requests    - the address to the list's `-request` address.
 
652
        $description      - the mailing list's description
 
653
        $info             - additional mailing list's information
 
654
 
 
655
        Personalized messages will also have these placeholders available:
 
656
 
 
657
        $user_name        - the name of the subscribing user.
 
658
        $user_address     - the email address of the subscribing user.
 
659
        $user_options_uri - the URI to this member's options page.
 
660
        """
 
661
        )
 
662
 
 
663
    digest_footer_uri = Attribute(
 
664
        """URI for the footer decorator on digest messages.
 
665
 
 
666
        This can be any URI supported by `urllib2` with the addition of
 
667
        `mailman:` URIs, which reference internal default resources.  This is
 
668
        a template which can include the following placeholders:
 
669
 
 
670
        $listname - the FQDN list name for this mailing list.
 
671
        $language - the language code, usually the list's preferred language.
 
672
 
 
673
        The resource will be downloaded and cached whenever the decorator is
 
674
        needed.  The resource at this URI can contain the following
 
675
        placeholders, which are also filled in through values on the mailing
 
676
        list:
 
677
 
 
678
        $fqdn_listname    - the FQDN list name for this mailing list.
 
679
        $list_name        - the human readable name for the mailing list.
 
680
        $host_name        - the mailing list's host name
 
681
        $listinfo_uri     - the URI to the list's information page.
 
682
        $list_requests    - the address to the list's `-request` address.
 
683
        $description      - the mailing list's description
 
684
        $info             - additional mailing list's information
 
685
 
 
686
        Personalized messages will also have these placeholders available:
 
687
 
 
688
        $user_name        - the name of the subscribing user.
 
689
        $user_address     - the email address of the subscribing user.
 
690
        $user_options_uri - the URI to this member's options page.
 
691
        """
 
692
        )
 
693
 
575
694
 
576
695
 
577
696
class IAcceptableAlias(Interface):