cPanel API 2 Functions - Email::has_delegated_mailman_lists - Knowledgebase

Description

This function checks whether an email account possesses administrative privileges on any mailing lists.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Email::has_delegated_mailman_lists — This function checks an account's administrative privileges on mailing lists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=has_delegated_mailman_lists&delegate=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Check whether user@example.com is a mailing list admin.
$is_list_admin = $cpanel->api2(
    '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 $is_list_admin = $cpliveapi->api2(
    'Email', 'has_delegated_mailman_lists',
    {
        'delegate'        => 'user@example.com',
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --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)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "has_delegated_mailman_lists",
    "data": [
      {
        "has_delegated_mailman_lists": "1",
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

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

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
has_delegated_mailman_lists	Boolean	Whether the email address possesses administrative privileges on one or more mailing lists on the cPanel account.	1 — The email address possesses administrative privileges. 0 — The email address does notpossess administrative privileges.	1
reason	string	A reason for failure. Note: This function only returns a reason value if it failed.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories