UAPI Functions - Email::has_delegated_mailman_lists

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

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

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

 cPanel Template Toolkit

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

 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.

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": 1,
  "metadata": {
    "transformed": 1
  }
}

 

Note:

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

 

Parameters

 Parameter 

Type

Description

Possible values

Example

delegate

 string 

Required

 The email address. 

 A valid email address. 

 user@example.com 

 

Returns

 Return 

Type

Description

Possible values

 Example 

data

 Boolean 

 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 nothave administrative privileges. 

 

1

 

  • 10 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....