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

--create or -c

<maillist>

Creates a mailing list with the specified name on a certain domain.

Requires -domain, -passwd, -email options.

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

--update or -u

<maillist>

Updates mailing list properties.

Requires -domain option.

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

--update-service

<domain name>

Updates mail service status on a domain.

Requires the -status option.

To enable mailing list service on the domain example.com:

maillist.exe --update-service example.com -status enabled

--on

<domain name>

Enables mailing list service on a domain.

To enable mailing list service on the domain example.com:

maillist.exe --on example.com

--off

<domain name>

Disables mailing list service on a domain.

To disable mailing list service on the domain example.com:

maillist.exe --off example.com

--remove or -r

<maillist>

Deletes the specified mailing list.

Requires -domain option.

To remove the mailing list Friends from example.com:

maillist.exe --remove Friends -domain example.com

or

maillist.exe -r Friends -domain example.com

--info or -i

<maillist>

Displays the list of members added to the specified mailing list.

Requires -domain option.

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

--help or -h

 

Displays help on the use of the utility.

To see the help info on the use of the maillist.exe utility:

maillist.exe –-help

or

maillist.exe –h

 

Options
Option Parameter Description Example

-domain

<domain name>

Specifies a domain name.

Required with all commands, except for --help.

To remove the mailing list Friends from the domain example.com:

maillist.exe --remove Friends -domain example.com

-passwd

<password>

Sets the mailing list administrator’s password.

Used with --create command only.

To set the password of Friends mailing list administrator to mypass:

maillist.exe --create Friends -domain example.com -passwd mypass

-email

<email>

Sets the email address of the mailing list administrator.

Used with --create command only.

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

-notify

true|false

Enables/Disables notifying the mailing list administrator about a mailing list creation.

Is true by default.

Used with the --create command only.

To disable sending notification for the Friends mailing list administrator:

maillist.exe --create Friends -notify false

-status

enabled|disabled|admin,domadm,parent,client,expired|true|false

Enables/Disables mailing lists service on a domain (the enabled or disabled parameters, respectively).

admin disables the service and sets its status to This service is disabled by administrator

client disables the service and sets its status to

Domain mail service is disabled by client.

parent sets the service status to the status of the domain.

The use of the domadm parameter is restricted; the parameter should not be used for changing the service status.

Is enabled by default.

To disable the Friends mailing list on domain example.com:

maillist.exe --update Friends -domain example.com -status disabled

-members

add|del:<email 1>[,<email 2>[,...]]

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

 

 

Leave your comments on this page

Leave your feedback or question on this documentation topic below. For technical assistance, contact your hosting service provider or submit a request to Plesk support. Suggest new features for Plesk here. Discuss general questions on the Plesk forum. All offtopic comments will be removed.