Create mailing list

This function creates a Mailman mailing list.

Important:

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

Authorizations:
query Parameters
domain
required
string <domain>

The domain.

Example: domain=example.com
list
required
string

The mailing list name.

Example: list=newlist
password
required
string

The mailing list password.

Example: password=12345luggage
private
integer
Default: 0

Whether the mailing list is private.

  • 1 — Private.
  • 0 — Public.
Enum: 0 1
Example: private=0
rebuildonly
integer
Default: 0

Whether to rebuild the mailing list.

  • 1 — Rebuild the mailing list.
  • 0 — Do not rebuild the mailing list.
Enum: 0 1
Example: rebuildonly=0

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 \
  add_list \
  list='newlist' \
  password='12345luggage' \
  domain='example.com'

Response samples

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