UAPI Functions - Email::get_mailman_delegates - Knowledgebase

Description

This function lists a mailing list's administrators.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/get_mailman_delegates?list=mylist

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// List the mylist mailing list's admins.
$get_admin = $cpanel->uapi(
    'Email', 'get_mailman_delegates',
    array(
        'list'        => 'mylist',
         )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List the mylist mailing list's admins.
my $get_admin = $cpliveapi->uapi(
    'Email', 'get_mailman_delegates',
    {
        'list'        => 'mylist',
    }
);

cPanel Template Toolkit

[% execute('Email', 'get_mailman_delegates', { 'list' => 'mylist', }) %]

Command Line

uapi --user=username Email get_mailman_delegates list=mylist

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": {
    "delegates": [
      "admin@example.com",
      "user@example.com",
    ],
  "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
list	string	Required The mailing list.	The name of a Mailman mailing list on the cPanel account.	mylist

Parameter

Type

Description

Possible values

Example

list

string

Required

The mailing list.

The name of a Mailman mailing list on the cPanel account.

mylist

Returns

Return	Type	Description	Possible values	Example
delegates	array	An array of the mailing list's administrators.	One or more email addresses.	secondadmin@example.com

Knowledgebase

Categories

Categories