UAPI Functions - Email::delete_list

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

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

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

 cPanel Template Toolkit

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

 Command Line

uapi --user=username Email delete_list list=mylist

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

uapi --user=username Email delete_list list=mylist

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 

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. 

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

mylist

 

Returns

This function only returns metadata.

  • 6 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....