Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function changes a mailing list's password.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/passwd_list?list=mylist&password=12345luggage

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.
 
// Change the password for the mylist mailing list.
$change_passwd = $cpanel->uapi(
    'Email', 'passwd_list',
    array(
        'list'        => 'mylist',
        'password'    => '12345luggage',
         )
);

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.
 
# Change the password for the mylist mailing list.
my $change_passwd = $cpliveapi->uapi(
    'Email', 'passwd_list',
    {
        'list'        => 'mylist',
        'password'    => '12345luggage',
    }
);

Note:

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

 

 cPanel Template Toolkit
<!-- Change the password for the mylist mailing list. -->
[% execute('Email', 'passwd_list', { 'list' => 'mylist', 'password' => '12345luggage', }) %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Email passwd_list list=mylist password=12345luggage

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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": null,
  "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
passwordstring

Required

The new password.

A secure password.12345luggage

Returns

This function only returns metadata.