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

 

Description

This function deletes a Mailman mailing list.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/delete_list?list=mylist

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.
 
// Delete the mylist mailing list.
$kill_list = $cpanel->uapi(
    'Email', 'delete_list',
    array(
        'list'        => 'mylist',
         )
);

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.
 
# Delete the mylist mailing list.
my $kill_list = $cpliveapi->uapi(
    'Email', 'delete_list',
    {
        'list'        => 'mylist',
    }
);

Note:

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

 

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

Note:

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

 

 Command Line
uapi --user=username Email delete_list list=mylist

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": [
    "Removing list info\nRemoving private archives\nRemoving private archives\nRemoving public archives\n"
  ],
  "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.

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

Returns

This function only returns metadata.