Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function creates a Mailman mailing list.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/add_list?list=newlist&password=12345luggage&domain=example.com

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Add a new mailing list.
$new_list = $cpanel->uapi(
    'Email', 'add_list',
    array(
        'list'       => 'newlist',
        'password'   => '12345luggage',
        'domain'     => 'example.com',
         )
);

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.
 
# Add a new mailing list.
my $new_list = $cpliveapi->uapi(
    'Email', 'add_list',
    {
        'list'       => 'newlist',
        'password'   => '12345luggage',
        'domain'     => 'example.com',
    }
);

Note:

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

 

 cPanel Template Toolkit
<!-- Add a new mailing list. -->
[% execute('Email', 'add_list', { 'list' => 'newlist', 'password' => '12345luggage', 'domain' => 'example.com', }) %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Email add_list list=newlist password=12345luggage domain=example.com

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "messages": [
    "Updated List newlist example.com\n",
    "Mailing list newlist created successfully."
  ],
  "errors": null,
  "status": 1,
  "data": null,
  "metadata": {
    "transformed": 1
  }
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
liststring

Required

The mailing list name.

A valid mailing list name.

newlist
passwordstring

Required

The mailing list password.

A secure password.

12345luggage
domainstring

Required

The domain.

A valid domain on the cPanel account.

example.com
rebuildonlyBoolean

Whether to rebuild the mailing list.

This parameter defaults to 0.

  • 1 — Rebuild the mailing list.
  • 0 — Do not rebuild the mailing list.
0
privateBoolean

Whether the mailing list is private.

This parameter defaults to 0.

  • 1 — Private.
  • 0 — Public.
0

Returns

This function only returns metadata.