summaryrefslogtreecommitdiff
path: root/src/mailman/rest/docs/systemconf.rst
diff options
context:
space:
mode:
authorBarry Warsaw2016-12-31 13:27:20 -0500
committerBarry Warsaw2016-12-31 13:27:20 -0500
commit286eac42626b5a2989d9d1142bff8e8911cf77c2 (patch)
tree843bbda5cd4643c6bf1b8d851ce6273b6eb4dc72 /src/mailman/rest/docs/systemconf.rst
parent192d76f1330041336a1f5793646df36a932210f0 (diff)
downloadmailman-286eac42626b5a2989d9d1142bff8e8911cf77c2.tar.gz
mailman-286eac42626b5a2989d9d1142bff8e8911cf77c2.tar.zst
mailman-286eac42626b5a2989d9d1142bff8e8911cf77c2.zip
Diffstat (limited to 'src/mailman/rest/docs/systemconf.rst')
-rw-r--r--src/mailman/rest/docs/systemconf.rst14
1 files changed, 10 insertions, 4 deletions
diff --git a/src/mailman/rest/docs/systemconf.rst b/src/mailman/rest/docs/systemconf.rst
index 24c6bef4a..8f7144d97 100644
--- a/src/mailman/rest/docs/systemconf.rst
+++ b/src/mailman/rest/docs/systemconf.rst
@@ -9,14 +9,12 @@ get a list of all defined sections.
http_etag: ...
sections: ['antispam', 'archiver.mail_archive', 'archiver.master', ...
-You can also get all the values for a particular section.
+You can also get all the values for a particular section, such as the
+``[mailman]`` section...
>>> dump_json('http://localhost:9001/3.0/system/configuration/mailman')
cache_life: 7d
default_language: en
- dmarc_org_domain_data: https://publicsuffix.org/list/public_suffix_list.dat
- dmarc_resolver_lifetime: 5s
- dmarc_resolver_timeout: 3s
email_commands_max_lines: 10
filtered_messages_are_preservable: no
html_to_plain_text_command: /usr/bin/lynx -dump $filename
@@ -29,6 +27,14 @@ You can also get all the values for a particular section.
sender_headers: from from_ reply-to sender
site_owner: noreply@example.com
+...or the ``[dmarc]`` section (or any other).
+
+ >>> dump_json('http://localhost:9001/3.0/system/configuration/dmarc')
+ http_etag: ...
+ org_domain_data_url: https://publicsuffix.org/list/public_suffix_list.dat
+ resolver_lifetime: 5s
+ resolver_timeout: 3s
+
Dotted section names work too, for example, to get the French language
settings section.