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

 

Description

This function removes an account's mailing list administrative privileges.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/remove_mailman_delegates?list=mylist&delegates=user%40example.com%2Cadmin%40example.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.
 
// Remove user@example.com and admin@example.com as admins.
$delete_admin = $cpanel->uapi(
    'Email', 'remove_mailman_delegates',
    array(
        'list'        => 'mylist',
        'delegate'    => 'user@example.com,admin@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.
 
# Remove user@example.com and admin@example.com as admins.
my $delete_admin = $cpliveapi->uapi(
    'Email', 'remove_mailman_delegates',
    {
        'list'        => 'mylist',
        'delegate'    => 'user@example.com,admin@example.com',
    }
);

Note:

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

 

 cPanel Template Toolkit
<!-- Remove user@example.com and admin@example.com as admins. -->
[% execute('Email', 'remove_mailman_delegates', { 'list' => 'mylist', 'delegate' => 'user@example.com,admin@example.com', }) %]

Note:

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

 

 Command Line
uapi --user=username Email remove_mailman_delegates list=mylist delegates=user%40example.com%2Cadmin%40example.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": null,
  "errors": null,
  "status": 1,
  "data": {
    "delegates": [
      "secondadmin@example.com",
    ],
  "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
delegatesstring

Required

A list of the administrators to remove.

One or more email addresses.

Note:

Separate multiple email addresses with commas. 

user@example.com,admin@example.com

Returns

ReturnTypeDescriptionPossible valuesExample
delegatesarray

An array of the mailing list's administrators.

One or more email addresses.

secondadmin@example.com