cPanel API 2 Functions - Email::has_delegated_mailman_lists

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

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.

Important:

When you disable the Receive Mail role, the system disables this function.

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="user@example.com"

Note:

For more information, read our Calls from the WHM API documentation.

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

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 $is_list_admin = $cpliveapi->api2(
    'Email', 'has_delegated_mailman_lists',
    {
        'delegate'        => 'user@example.com',
    }
);

Note:

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

cPanel Tag System (deprecated)

Warnings:

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

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.
You must run the --user=username command.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

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 (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`delegate`	string	Required The email address.	A valid email address.	`user@example.com`

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 not possess 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`