UAPI Functions - Email::add_mailman_delegates - Knowledgebase

Description

This function grants mailing list administrative privileges to users.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/add_mailman_delegates?list=mylist&delegates=user%40example.com%2Cadmin%40example.com

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Add user@example.com and admin@example.com as admins.
$add_admin = $cpanel->uapi(
    'Email', 'add_mailman_delegates',
    array(
        'list'        => 'mylist',
        'delegate'    => 'user@example.com,admin@example.com',
         )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Add user@example.com and admin@example.com as admins.
my $add_admin = $cpliveapi->uapi(
    'Email', 'add_mailman_delegates',
    {
        'list'        => 'mylist',
        'delegate'    => 'user@example.com,admin@example.com',
    }
);

cPanel Template Toolkit

[% execute('Email', 'add_mailman_delegates', { 'list' => 'mylist', 'delegate' => 'user@example.com,admin@example.com', }) %]

Command Line

uapi --user=username Email add_mailman_delegates list=mylist delegates=user%40example.com%2Cadmin%40example.com

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
delegates	string	Required A list of the administrators to add.	One or more email addresses. Note: Separate multiple email addresses with commas.	user@example.com,admin@example.com

Parameter

Type

Description

Possible values

Example

list

string

Required

The mailing list.

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

mylist

delegates

string

Required

A list of the administrators to add.

One or more email addresses.

Note:

Separate multiple email addresses with commas.

user@example.com,admin@example.com

Returns

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

Knowledgebase

Categories

Categories