Child pages
  • cPanel API 1 Functions - Email::addlist
Skip to end of metadata
Go to start of metadata

 

Description

This function adds a Mailman mailing list.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$new_mailing_list = $cpanel->api1('Email', 'addlist', array('newlist', '12345luggage', 'example.com') ); // Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $new_mailing_list = $cpliveapi->api1('Email', 'addlist', ['newlist', '12345luggage', 'example.com'] ); # Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Email::addlist( $FORM('list','password','domain') )">
 Command Line
cpapi1 --user=username Email addlist newlist 12345luggage example.com


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (none)

This function does not return output.

Parameters

ParameterTypeDescriptionPossible valuesExample
list

string

Required

The mailing list name.

Any valid string.newlist
passwordstring

Required

The mailing list password.

A secure password.

12345luggage
domainstring

Required

The domain on which to create the mailing list.

A valid domain on the server.

example.com

Returns

This function does not return output.