Update mailing list privacy options

This function modifies a Mailman mailing list's privacy options.

Important:

When you disable the Receive Mail role, the system disables this function.

Authorizations:
query Parameters
advertised
required
integer

Whether the Mailman directory page displays the list.

  • 1 - Display.
  • 0 - Does not display.
Enum: 0 1
Example: advertised=1
archive_private
required
integer

Whether the mailing list archive is private.

  • 1 - Private.
  • 0 - Public.
Enum: 0 1
Example: archive_private=1
list
required
string

The mailing list name.

Example: list=mylist
subscribe_policy
required
integer

The level of control that the mailing list administrator has over new subscribers.

  • 1 - Anyone can subscribe. The system sends a confirmation email.
  • 2 - The administrator must approve subscriptions. The system does not send a confirmation email.
  • 3 - The administrator must approve subscriptions. The system sends a confirmation email.
Enum: 1 2 3
Example: subscribe_policy=1

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  Email \
  set_list_privacy_options \
  list='mylist' \
  advertised='1' \
  archive_private='1' \
  subscribe_policy='1'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "set_list_privacy_options",
  • "module": "Email",
  • "result": {
    • "data": null,
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}