UAPI Functions - Email::passwd_list

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

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

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

 cPanel Template Toolkit

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

 Command Line

uapi --user=username Email passwd_list list=mylist

 

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": null,
  "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

password

string

Required

 The new password. 

A secure password.

 12345luggage 

 

Returns

This function only returns metadata.

  • 12 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....