You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Child pages
  • UAPI Functions - Email::get_mailman_delegates
Skip to end of metadata
Go to start of metadata

Description

This function lists a mailing list's administrators.

Important:

In cPanel & WHM version 76 and later, when you disable the Receive Mail role, the system disables this function.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/get_mailman_delegates?list=mylist


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

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


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.
 
# List the mylist mailing list's admins.
my $get_admin = $cpliveapi->uapi(
    'Email', 'get_mailman_delegates',
    {
        'list'        => 'mylist',
    }
);


Note:

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


 Command Line
uapi --user=username Email get_mailman_delegates list=mylist


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


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

Parameters

ParameterTypeDescriptionPossible valuesExample
liststring

Required

The mailing list.

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

Returns

ReturnTypeDescriptionPossible valuesExample
delegatesarray

An array of the mailing list's administrators.

One or more email addresses.

secondadmin@example.com