maillist.exe: Mailing Lists
The maillist.exe utility serves to manage mailing lists. The utility allows the following:
- creating and removing mailing lists
- adding and removing mail addresses to/from mailing lists
- modifying mail and notification settings of the mailing list administrator
Location
%plesk_cli%
Usage
maillist.exe <command> [<maillist>] [
<option 1> <param 1>[,<param 2>,
,<param n>]
[<option 2> <param 1>[,<param 2>,
,<param n>]]
[<option N> <param 1>[,<param 2>,
,<param n>]]
]
Example
The following command creates the Work mailing list on the example.com domain, sets the MyPass password for the mailing list administrator, orders not to send the mailing list created notification to this administrator, and sets the adminlist@example.com email address for this administrator.
maillist.exe --create Work -domain example.com -passwd MyPass -notify false -email adminlist@example.com
Commands
| Command | Parameter | Description | Example |
|---|---|---|---|
|
|
|
Creates a mailing list with the specified name on a certain domain. Requires |
To create the mailing list Friends on example.com: maillist.exe --create Friends -domain example.com -passwd MyPass -email adminlist@example.com or maillist.exe -c Friends -domain example.com -passwd MyPass -email adminlist@example.com |
|
|
|
Updates mailing list properties. Requires |
To update the mailing list Friends with addresses jane@example.com, john@example.name: maillist.exe --update Friends -members add:jane@example.com,john@example.com -domain example.com or maillist.exe -u Friends -members add:jane@example.com,john@example.com -domain example.com |
|
|
|
Updates mail service status on a domain. Requires the |
To enable mailing list service on the domain example.com: maillist.exe --update-service example.com -status enabled |
|
|
|
Enables mailing list service on a domain. |
To enable mailing list service on the domain example.com: maillist.exe --on example.com |
|
|
|
Disables mailing list service on a domain. |
To disable mailing list service on the domain example.com: maillist.exe --off example.com |
|
|
|
Deletes the specified mailing list. Requires |
To remove the mailing list Friends from example.com: maillist.exe --remove Friends -domain example.com or maillist.exe -r Friends -domain example.com |
|
|
|
Displays the list of members added to the specified mailing list. Requires |
To see the list of members added to the mailing list Friends on example.com: maillist.exe --info Friends -domain example.com or maillist.exe -i Friends -domain example.com |
|
|
|
Displays help on the use of the utility. |
To see the help info on the use of the maillist.exe –-help or maillist.exe –h |
Options
| Option | Parameter | Description | Example |
|---|---|---|---|
|
|
|
Specifies a domain name. Required with all commands, except for |
To remove the mailing list Friends from the domain example.com: maillist.exe --remove Friends -domain example.com |
|
|
|
Sets the mailing list administrator’s password. Used with |
To set the password of Friends mailing list administrator to mypass: maillist.exe --create Friends -domain example.com -passwd mypass |
|
|
|
Sets the email address of the mailing list administrator. Used with |
To set the email address of the Friends mailing list administrator to admin@example.com: maillist.exe --create Friends -domain example.com -email Admin@example.com |
|
|
|
Enables/Disables notifying the mailing list administrator about a mailing list creation. Is Used with the |
To disable sending notification for the Friends mailing list administrator: maillist.exe --create Friends -notify false |
|
|
|
Enables/Disables mailing lists service on a domain (the
Domain mail service is disabled by client.
The use of the Is |
To disable the Friends mailing list on domain example.com: maillist.exe --update Friends -domain example.com -status disabled |
|
|
|
Adds/Deletes email addresses to/from a specified mailing list. |
To add email addresses Jane@example.com, JohnDoe@example.com to the Friends mailing list on domain example.com: maillist.exe --update Friends -members add:Jane@example.name,JohnDoe@example.com -domain example.com |