summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/mailman/interfaces/mailinglist.py7
-rw-r--r--src/mailman/model/mailinglist.py22
-rw-r--r--src/mailman/rest/docs/configuration.txt9
-rw-r--r--src/mailman/rest/lists.py2
4 files changed, 29 insertions, 11 deletions
diff --git a/src/mailman/interfaces/mailinglist.py b/src/mailman/interfaces/mailinglist.py
index 26373eb11..53f462d5d 100644
--- a/src/mailman/interfaces/mailinglist.py
+++ b/src/mailman/interfaces/mailinglist.py
@@ -99,6 +99,13 @@ class IMailingList(Interface):
Subject prefix.
""")
+ description = Attribute("""\
+ A terse phrase identifying this mailing list.
+
+ This description is used when the mailing list is listed with other
+ mailing lists, or in headers, and so forth. It should be as succinct
+ as you can get it, while still identifying what the list is.""")
+
list_id = Attribute(
"""The RFC 2919 List-ID header value.""")
diff --git a/src/mailman/model/mailinglist.py b/src/mailman/model/mailinglist.py
index e7dec473e..5a6f26725 100644
--- a/src/mailman/model/mailinglist.py
+++ b/src/mailman/model/mailinglist.py
@@ -109,17 +109,17 @@ class MailingList(Model):
collapse_alternatives = Bool()
convert_html_to_plaintext = Bool()
# Bounces and bans.
- ban_list = Pickle()
- bounce_info_stale_after = TimeDelta()
- bounce_matching_headers = Unicode()
- bounce_notify_owner_on_disable = Bool()
- bounce_notify_owner_on_removal = Bool()
- bounce_processing = Bool()
- bounce_score_threshold = Int()
- bounce_unrecognized_goes_to_list_owner = Bool()
- bounce_you_are_disabled_warnings = Int()
- bounce_you_are_disabled_warnings_interval = TimeDelta()
- default_member_moderation = Bool()
+ ban_list = Pickle() # XXX
+ bounce_info_stale_after = TimeDelta() # XXX
+ bounce_matching_headers = Unicode() # XXX
+ bounce_notify_owner_on_disable = Bool() # XXX
+ bounce_notify_owner_on_removal = Bool() # XXX
+ bounce_processing = Bool() # XXX
+ bounce_score_threshold = Int() # XXX
+ bounce_unrecognized_goes_to_list_owner = Bool() # XXX
+ bounce_you_are_disabled_warnings = Int() # XXX
+ bounce_you_are_disabled_warnings_interval = TimeDelta() # XXX
+ default_member_moderation = Bool() # XXX
description = Unicode()
digest_footer = Unicode()
digest_header = Unicode()
diff --git a/src/mailman/rest/docs/configuration.txt b/src/mailman/rest/docs/configuration.txt
index 54d29fead..9cb30f045 100644
--- a/src/mailman/rest/docs/configuration.txt
+++ b/src/mailman/rest/docs/configuration.txt
@@ -31,6 +31,7 @@ All readable attributes for a list are available on a sub-resource.
collapse_alternatives: True
convert_html_to_plaintext: False
created_at: 20...T...
+ description:
digest_last_sent_at: None
digest_size_threshold: 30.0
filter_content: False
@@ -80,6 +81,7 @@ writable attributes in one request.
... autoresponse_postings_text='the mailing list',
... autoresponse_request_text='the robot',
... real_name='Fnords',
+ ... description='This is my mailing list',
... include_rfc2369_headers=False,
... include_list_post_header=False,
... digest_size_threshold=10.5,
@@ -114,6 +116,8 @@ These values are changed permanently.
collapse_alternatives: False
convert_html_to_plaintext: True
...
+ description: This is my mailing list
+ ...
digest_size_threshold: 10.5
filter_content: True
...
@@ -144,6 +148,7 @@ be included. It is an error to leave one out (e.g. `pipeline`)...
... autoresponse_postings_text='the mailing list',
... autoresponse_request_text='the robot',
... real_name='Fnords',
+ ... description='This is my mailing list',
... include_rfc2369_headers=False,
... include_list_post_header=False,
... digest_size_threshold=10.5,
@@ -176,6 +181,7 @@ be included. It is an error to leave one out (e.g. `pipeline`)...
... autoresponse_postings_text='the mailing list',
... autoresponse_request_text='the robot',
... real_name='Fnords',
+ ... description='This is my mailing list',
... include_rfc2369_headers=False,
... include_list_post_header=False,
... digest_size_threshold=10.5,
@@ -207,6 +213,7 @@ It is also an error to spell an attribute value incorrectly...
... autoresponse_postings_text='the mailing list',
... autoresponse_request_text='the robot',
... real_name='Fnords',
+ ... description='This is my mailing list',
... include_rfc2369_headers=False,
... include_list_post_header=False,
... digest_size_threshold=10.5,
@@ -237,6 +244,7 @@ It is also an error to spell an attribute value incorrectly...
... autoresponse_postings_text='the mailing list',
... autoresponse_request_text='the robot',
... real_name='Fnords',
+ ... description='This is my mailing list',
... include_rfc2369_headers=False,
... include_list_post_header=False,
... digest_size_threshold=10.5,
@@ -267,6 +275,7 @@ It is also an error to spell an attribute value incorrectly...
... autoresponse_postings_text='the mailing list',
... autoresponse_request_text='the robot',
... real_name='Fnords',
+ ... description='This is my mailing list',
... include_rfc2369_headers=False,
... include_list_post_header=False,
... digest_size_threshold=10.5,
diff --git a/src/mailman/rest/lists.py b/src/mailman/rest/lists.py
index 26aabbf49..31c5dcfb0 100644
--- a/src/mailman/rest/lists.py
+++ b/src/mailman/rest/lists.py
@@ -225,6 +225,7 @@ READABLE = (
'host_name',
'fqdn_listname',
'real_name',
+ 'description',
'list_id',
'include_list_post_header',
'include_rfc2369_headers',
@@ -291,6 +292,7 @@ class enum_validator:
VALIDATORS = {
# Identity.
'real_name': unicode,
+ 'description': unicode,
'include_list_post_header': as_boolean,
'include_rfc2369_headers': as_boolean,
'advertised': as_boolean,