~barry/mailman/lp1423756

« back to all changes in this revision

Viewing changes to src/mailman/rest/docs/systemconf.rst

Committer: Barry Warsaw
Date: 2015-01-05 01:20:33 UTC
mfrom: (7264.4.66 py3)
Revision ID: barry@list.org-20150105012033-zdrw9c2odhpf22fz

Merge the Python 3 branch.

files added:
src/mailman/handlers/subject_prefix.py

src/mailman/handlers/tests/test_file_recips.py

src/mailman/handlers/tests/test_filter.py

src/mailman/handlers/tests/test_subject_prefix.py

src/mailman/model/tests/test_messagestore.py

src/mailman/model/tests/test_registrar.py

src/mailman/mta/tests/test_connection.py

src/mailman/rest/docs/queues.rst

src/mailman/rest/docs/systemconf.rst

src/mailman/rest/queues.py

src/mailman/rest/tests/test_queues.py

src/mailman/rest/tests/test_systemconf.py

files removed:
src/mailman/rest/docs/systemconf.rst

src/mailman/rest/tests/test_systemconf.py

files modified:
.bzrignore

coverage.ini

setup.py

src/mailman/__init__.py

src/mailman/app/bounces.py

src/mailman/app/commands.py

src/mailman/app/docs/hooks.rst

src/mailman/app/docs/pipelines.rst

src/mailman/app/docs/subscriptions.rst

src/mailman/app/domain.py

src/mailman/app/events.py

src/mailman/app/inject.py

src/mailman/app/lifecycle.py

src/mailman/app/membership.py

src/mailman/app/moderator.py

src/mailman/app/notifications.py

src/mailman/app/registrar.py

src/mailman/app/replybot.py

src/mailman/app/subscriptions.py

src/mailman/app/templates.py

src/mailman/app/tests/test_bounces.py

src/mailman/app/tests/test_inject.py

src/mailman/app/tests/test_lifecycle.py

src/mailman/app/tests/test_membership.py

src/mailman/app/tests/test_moderation.py

src/mailman/app/tests/test_notifications.py

src/mailman/app/tests/test_registration.py

src/mailman/app/tests/test_subscriptions.py

src/mailman/app/tests/test_templates.py

src/mailman/archiving/mailarchive.py

src/mailman/archiving/mhonarc.py

src/mailman/archiving/prototype.py

src/mailman/archiving/tests/test_prototype.py

src/mailman/bin/export.py

src/mailman/bin/gate_news.py

src/mailman/bin/mailman.py

src/mailman/bin/master.py

src/mailman/bin/onebounce.py

src/mailman/bin/runner.py

src/mailman/bin/tests/test_master.py

src/mailman/chains/accept.py

src/mailman/chains/base.py

src/mailman/chains/builtin.py

src/mailman/chains/discard.py

src/mailman/chains/headers.py

src/mailman/chains/hold.py

src/mailman/chains/moderation.py

src/mailman/chains/owner.py

src/mailman/chains/reject.py

src/mailman/chains/tests/test_base.py

src/mailman/chains/tests/test_headers.py

src/mailman/chains/tests/test_hold.py

src/mailman/chains/tests/test_owner.py

src/mailman/commands/cli_aliases.py

src/mailman/commands/cli_conf.py

src/mailman/commands/cli_control.py

src/mailman/commands/cli_help.py

src/mailman/commands/cli_import.py

src/mailman/commands/cli_info.py

src/mailman/commands/cli_inject.py

src/mailman/commands/cli_lists.py

src/mailman/commands/cli_members.py

src/mailman/commands/cli_qfile.py

src/mailman/commands/cli_status.py

src/mailman/commands/cli_unshunt.py

src/mailman/commands/cli_version.py

src/mailman/commands/cli_withlist.py

src/mailman/commands/docs/echo.rst

src/mailman/commands/docs/help.rst

src/mailman/commands/docs/info.rst

src/mailman/commands/docs/inject.rst

src/mailman/commands/docs/members.rst

src/mailman/commands/docs/membership.rst

src/mailman/commands/docs/qfile.rst

src/mailman/commands/docs/withlist.rst

src/mailman/commands/eml_confirm.py

src/mailman/commands/eml_echo.py

src/mailman/commands/eml_end.py

src/mailman/commands/eml_help.py

src/mailman/commands/eml_membership.py

src/mailman/commands/tests/test_conf.py

src/mailman/commands/tests/test_confirm.py

src/mailman/commands/tests/test_control.py

src/mailman/commands/tests/test_create.py

src/mailman/commands/tests/test_help.py

src/mailman/config/__init__.py

src/mailman/config/config.py

src/mailman/config/mailman.cfg

src/mailman/config/schema.cfg

src/mailman/config/tests/test_archivers.py

src/mailman/config/tests/test_configuration.py

src/mailman/core/chains.py

src/mailman/core/constants.py

src/mailman/core/docs/runner.rst

src/mailman/core/errors.py

src/mailman/core/i18n.py

src/mailman/core/initialize.py

src/mailman/core/logging.py

src/mailman/core/pipelines.py

src/mailman/core/rules.py

src/mailman/core/runner.py

src/mailman/core/switchboard.py

src/mailman/core/system.py

src/mailman/core/tests/test_pipelines.py

src/mailman/core/tests/test_runner.py

src/mailman/database/alembic/__init__.py

src/mailman/database/alembic/env.py

src/mailman/database/alembic/versions/51b7f92bd06c_initial.py

src/mailman/database/base.py

src/mailman/database/factory.py

src/mailman/database/model.py

src/mailman/database/postgresql.py

src/mailman/database/sqlite.py

src/mailman/database/tests/test_factory.py

src/mailman/database/transaction.py

src/mailman/database/types.py

src/mailman/docs/DEVELOP.rst

src/mailman/docs/INTRODUCTION.rst

src/mailman/docs/NEWS.rst

src/mailman/docs/START.rst

src/mailman/docs/STYLEGUIDE.rst

src/mailman/docs/__init__.py

src/mailman/email/message.py

src/mailman/email/tests/test_message.py

src/mailman/email/validate.py

src/mailman/handlers/acknowledge.py

src/mailman/handlers/after_delivery.py

src/mailman/handlers/avoid_duplicates.py

src/mailman/handlers/cleanse.py

src/mailman/handlers/cleanse_dkim.py

src/mailman/handlers/cook_headers.py

src/mailman/handlers/decorate.py

src/mailman/handlers/docs/acknowledge.rst

src/mailman/handlers/docs/avoid-duplicates.rst

src/mailman/handlers/docs/digests.rst

src/mailman/handlers/docs/file-recips.rst

src/mailman/handlers/docs/filtering.rst

src/mailman/handlers/docs/nntp.rst

src/mailman/handlers/docs/replybot.rst

src/mailman/handlers/docs/rfc-2369.rst

src/mailman/handlers/docs/subject-munging.rst

src/mailman/handlers/docs/tagger.rst

src/mailman/handlers/docs/to-outgoing.rst

src/mailman/handlers/file_recipients.py

src/mailman/handlers/member_recipients.py

src/mailman/handlers/mime_delete.py

src/mailman/handlers/owner_recipients.py

src/mailman/handlers/replybot.py

src/mailman/handlers/rfc_2369.py

src/mailman/handlers/tagger.py

src/mailman/handlers/tests/test_cook_headers.py

src/mailman/handlers/tests/test_mimedel.py

src/mailman/handlers/tests/test_recipients.py

src/mailman/handlers/tests/test_to_digest.py

src/mailman/handlers/to_archive.py

src/mailman/handlers/to_digest.py

src/mailman/handlers/to_outgoing.py

src/mailman/handlers/to_usenet.py

src/mailman/interfaces/action.py

src/mailman/interfaces/address.py

src/mailman/interfaces/archiver.py

src/mailman/interfaces/autorespond.py

src/mailman/interfaces/bans.py

src/mailman/interfaces/bounce.py

src/mailman/interfaces/chain.py

src/mailman/interfaces/command.py

src/mailman/interfaces/configuration.py

src/mailman/interfaces/database.py

src/mailman/interfaces/digests.py

src/mailman/interfaces/domain.py

src/mailman/interfaces/errors.py

src/mailman/interfaces/handler.py

src/mailman/interfaces/languages.py

src/mailman/interfaces/listmanager.py

src/mailman/interfaces/mailinglist.py

src/mailman/interfaces/member.py

src/mailman/interfaces/messages.py

src/mailman/interfaces/mime.py

src/mailman/interfaces/mlistrequest.py

src/mailman/interfaces/mta.py

src/mailman/interfaces/nntp.py

src/mailman/interfaces/pending.py

src/mailman/interfaces/permissions.py

src/mailman/interfaces/pipeline.py

src/mailman/interfaces/preferences.py

src/mailman/interfaces/registrar.py

src/mailman/interfaces/requests.py

src/mailman/interfaces/roster.py

src/mailman/interfaces/rules.py

src/mailman/interfaces/runner.py

src/mailman/interfaces/styles.py

src/mailman/interfaces/subscriptions.py

src/mailman/interfaces/switchboard.py

src/mailman/interfaces/system.py

src/mailman/interfaces/templates.py

src/mailman/interfaces/user.py

src/mailman/interfaces/usermanager.py

src/mailman/languages/language.py

src/mailman/languages/manager.py

src/mailman/model/address.py

src/mailman/model/autorespond.py

src/mailman/model/bans.py

src/mailman/model/bounce.py

src/mailman/model/digests.py

src/mailman/model/docs/addresses.rst

src/mailman/model/docs/domains.rst

src/mailman/model/docs/languages.rst

src/mailman/model/docs/listmanager.rst

src/mailman/model/docs/mailinglist.rst

src/mailman/model/docs/membership.rst

src/mailman/model/docs/messagestore.rst

src/mailman/model/docs/pending.rst

src/mailman/model/docs/registration.rst

src/mailman/model/docs/usermanager.rst

src/mailman/model/docs/users.rst

src/mailman/model/domain.py

src/mailman/model/language.py

src/mailman/model/listmanager.py

src/mailman/model/mailinglist.py

src/mailman/model/member.py

src/mailman/model/message.py

src/mailman/model/messagestore.py

src/mailman/model/mime.py

src/mailman/model/pending.py

src/mailman/model/preferences.py

src/mailman/model/requests.py

src/mailman/model/roster.py

src/mailman/model/tests/test_address.py

src/mailman/model/tests/test_bounce.py

src/mailman/model/tests/test_domain.py

src/mailman/model/tests/test_listmanager.py

src/mailman/model/tests/test_mailinglist.py

src/mailman/model/tests/test_member.py

src/mailman/model/tests/test_requests.py

src/mailman/model/tests/test_roster.py

src/mailman/model/tests/test_uid.py

src/mailman/model/tests/test_user.py

src/mailman/model/uid.py

src/mailman/model/user.py

src/mailman/model/usermanager.py

src/mailman/mta/aliases.py

src/mailman/mta/base.py

src/mailman/mta/bulk.py

src/mailman/mta/connection.py

src/mailman/mta/decorating.py

src/mailman/mta/deliver.py

src/mailman/mta/docs/authentication.rst

src/mailman/mta/docs/bulk.rst

src/mailman/mta/docs/connection.rst

src/mailman/mta/exim4.py

src/mailman/mta/null.py

src/mailman/mta/personalized.py

src/mailman/mta/postfix.py

src/mailman/mta/tests/test_aliases.py

src/mailman/mta/tests/test_delivery.py

src/mailman/mta/verp.py

src/mailman/options.py

src/mailman/rest/addresses.py

src/mailman/rest/docs/__init__.py

src/mailman/rest/docs/addresses.rst

src/mailman/rest/docs/basic.rst

src/mailman/rest/docs/domains.rst

src/mailman/rest/docs/helpers.rst

src/mailman/rest/docs/membership.rst

src/mailman/rest/docs/moderation.rst

src/mailman/rest/docs/preferences.rst

src/mailman/rest/docs/users.rst

src/mailman/rest/domains.py

src/mailman/rest/helpers.py

src/mailman/rest/listconf.py

src/mailman/rest/lists.py

src/mailman/rest/members.py

src/mailman/rest/moderation.py

src/mailman/rest/preferences.py

src/mailman/rest/root.py

src/mailman/rest/templates.py

src/mailman/rest/tests/test_addresses.py

src/mailman/rest/tests/test_domains.py

src/mailman/rest/tests/test_listconf.py

src/mailman/rest/tests/test_lists.py

src/mailman/rest/tests/test_membership.py

src/mailman/rest/tests/test_moderation.py

src/mailman/rest/tests/test_paginate.py

src/mailman/rest/tests/test_preferences.py

src/mailman/rest/tests/test_root.py

src/mailman/rest/tests/test_users.py

src/mailman/rest/users.py

src/mailman/rest/validator.py

src/mailman/rest/wsgiapp.py

src/mailman/rules/administrivia.py

src/mailman/rules/any.py

src/mailman/rules/approved.py

src/mailman/rules/emergency.py

src/mailman/rules/implicit_dest.py

src/mailman/rules/loop.py

src/mailman/rules/max_recipients.py

src/mailman/rules/max_size.py

src/mailman/rules/moderation.py

src/mailman/rules/news_moderation.py

src/mailman/rules/no_subject.py

src/mailman/rules/suspicious.py

src/mailman/rules/tests/test_approved.py

src/mailman/rules/tests/test_moderation.py

src/mailman/rules/truth.py

src/mailman/runners/archive.py

src/mailman/runners/bounce.py

src/mailman/runners/command.py

src/mailman/runners/digest.py

src/mailman/runners/docs/command.rst

src/mailman/runners/docs/digester.rst

src/mailman/runners/docs/incoming.rst

src/mailman/runners/docs/lmtp.rst

src/mailman/runners/docs/nntp.rst

src/mailman/runners/docs/outgoing.rst

src/mailman/runners/incoming.py

src/mailman/runners/lmtp.py

src/mailman/runners/nntp.py

src/mailman/runners/outgoing.py

src/mailman/runners/pipeline.py

src/mailman/runners/rest.py

src/mailman/runners/retry.py

src/mailman/runners/tests/test_archiver.py

src/mailman/runners/tests/test_bounce.py

src/mailman/runners/tests/test_confirm.py

src/mailman/runners/tests/test_digest.py

src/mailman/runners/tests/test_incoming.py

src/mailman/runners/tests/test_join.py

src/mailman/runners/tests/test_lmtp.py

src/mailman/runners/tests/test_nntp.py

src/mailman/runners/tests/test_outgoing.py

src/mailman/runners/tests/test_owner.py

src/mailman/runners/tests/test_pipeline.py

src/mailman/runners/tests/test_rest.py

src/mailman/runners/tests/test_retry.py

src/mailman/runners/virgin.py

src/mailman/styles/base.py

src/mailman/styles/default.py

src/mailman/styles/manager.py

src/mailman/styles/tests/test_styles.py

src/mailman/testing/documentation.py

src/mailman/testing/helpers.py

src/mailman/testing/i18n.py

src/mailman/testing/layers.py

src/mailman/testing/mta.py

src/mailman/testing/nose.py

src/mailman/tests/test_configfile.py

src/mailman/utilities/datetime.py

src/mailman/utilities/email.py

src/mailman/utilities/filesystem.py

src/mailman/utilities/i18n.py

src/mailman/utilities/importer.py

src/mailman/utilities/interact.py

src/mailman/utilities/mailbox.py

src/mailman/utilities/modules.py

src/mailman/utilities/passwords.py

src/mailman/utilities/string.py

src/mailman/utilities/tests/test_email.py

src/mailman/utilities/tests/test_import.py

src/mailman/utilities/tests/test_passwords.py

src/mailman/utilities/tests/test_templates.py

src/mailman/utilities/tests/test_wrap.py

src/mailman/utilities/uid.py

template.py

tox.ini

Show diffs side-by-side

added added

removed removed

src/mailman/rest/docs/systemconf.rst

====================

System configuration

====================

The entire system configuration is available through the REST API. You can

get a list of all defined sections.

>>> dump_json('http://localhost:9001/3.0/system/configuration')

http_etag: ...

sections: ['antispam', 'archiver.mail_archive', 'archiver.master', ...

You can also get all the values for a particular section.

>>> dump_json('http://localhost:9001/3.0/system/configuration/mailman')

default_language: en

email_commands_max_lines: 10

filtered_messages_are_preservable: no

http_etag: ...

layout: testing

noreply_address: noreply

pending_request_life: 3d

post_hook:

pre_hook:

sender_headers: from from_ reply-to sender

site_owner: noreply@example.com

Dotted section names work too, for example, to get the French language

settings section.

>>> dump_json('http://localhost:9001/3.0/system/configuration/language.fr')

charset: iso-8859-1

description: French

enabled: yes

http_etag: ...

Older »