Description

This function deletes a Mailman mailing list.

Examples




https://hostname.example.com:2083/cpsess##########/execute/Email/delete_list?list=mylist



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Delete the mylist mailing list.
$kill_list = $cpanel->uapi(
    'Email', 'delete_list',
    array(
        'list'        => 'mylist',
         )
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Delete the mylist mailing list.
my $kill_list = $cpliveapi->uapi(
    'Email', 'delete_list',
    {
        'list'        => 'mylist',
    }
);

 



<!-- Delete the mylist mailing list. -->
[% execute('Email', 'delete_list', { 'list' => 'mylist', }) %]

 



uapi --user=username Email delete_list list=mylist



{
  "messages": [
    "Removing list info\nRemoving private archives\nRemoving private archives\nRemoving public archives\n"
  ],
  "errors": null,
  "status": 1,
  "data": null,
  "metadata": {
    "transformed": 1
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
liststring

Required

The mailing list.

The name of a Mailman mailing list on the cPanel account.mylist

Returns

This function only returns metadata.