Managing Mailing Lists

Operator: <maillist>

XML Schema: maillist.xsd

Plesk version: all versions

API RPC version: 1.4.2.0 and higher

Plesk user: Plesk Administrator, Plesk client

Description

The maillist operator is designed for managing mailing lists on domains. Each mailing list can be enabled or disabled. If it is disabled, the messages from mailing list owner will not be sent to subscribers. The mailing service (managing all mailing lists on a domain) can be activated or deactivated. If it is deactivated, all messages from all mailing list owners of a specified domain will not be sent to subscribers.

Mailing lists are provided by the GNU Mailman software. Before using the operator, make sure that the specified software is installed on your Plesk server.

Each mailing list should have unique name parameter. The e-mail address that is used for messages delivery to subscribers looks as follows: name@domain. The name of the mailing list cannot be changed.

Supported operations

• ADD-LIST adds a new mailing list to the specified domain
• DEL-LIST deletes mailing lists using filtering rules
• GET-LIST retrieves mailing lists name and status using filtering rules
• ADD-MEMBER adds a new subscriber to the specified mailing list
• GET-MEMBERS retrieves the subscribers of the specified mailing lists
• DEL-MEMBERS removes a subscriber from the specified mailing lists
• ENABLE activates the mailing list service on the specified domains
• DISABLE deactivates the mailing list service on the specified domains
• ENABLE-LIST activates the specified mailing lists
• DISABLE-LIST deactivates the specified mailing lists
• GET-STATUS retrieves the status of the mailing service on the specified domain