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

 

Description

This function checks an account's administrative privileges on mailing lists.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/has_delegated_mailman_lists?delegate=user%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.
 
// Check whether user@example.com is a mailing list admin.
$admin_check = $cpanel->uapi(
    'Email', 'has_delegated_mailman_lists',
    array(
        'delegate'       => 'user@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.
 
# Check whether user@example.com is a mailing list admin.
my $admin_check = $cpliveapi->uapi(
    'Email', 'has_delegated_mailman_lists',
    {
        'delegate'       => 'user@example.com',
    }
);

Note:

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

 

 cPanel Template Toolkit
<!-- Check whether user@example.com is a mailing list admin. -->
[% execute('Email', 'has_delegated_mailman_lists', { 'delegate' => 'user@example.com', }) %]

Note:

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

 

 Command Line
uapi --user=username Email has_delegated_mailman_lists delegate=user%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": 1,
  "metadata": {
    "transformed": 1
  }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
delegatestring

Required

The email address.

A valid email address.

user@example.com

Returns

ReturnTypeDescriptionPossible valuesExample
dataBoolean

Whether the email address has administrative privileges on one or more mailing lists on the cPanel account.

  • 1 — The email address has administrative privileges.
  • 0 — The email address does not have administrative privileges.

 

1