UAPI Functions - Email::add_list - Knowledgebase

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

 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',
         )
);

 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',
    }
);

cPanel Template Toolkit

[% execute('Email', 'add_list', { 'list' => 'newlist', 'password' => '12345luggage', 'domain' => 'example.com', }) %]

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.

 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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
list	string	Required The mailing list name.	A valid mailing list name.	newlist
password	string	Required The mailing list password.	A secure password.	12345luggage
domain	string	Required The domain.	A valid domain on the cPanel account.	example.com
rebuildonly	Boolean	Whether to rebuild the mailing list. This parameter defaults to 0.	1 — Rebuild the mailing list. 0 — Do not rebuild the mailing list.	0
private	Boolean	Whether the mailing list is private. This parameter defaults to 0.	1 — Private. 0 — Public.	0

Returns

This function only returns metadata.

Knowledgebase

Categories

Categories