cPanel API 1 Functions - Email::passwdlist - Knowledgebase

Description

This function modifies a mailing list's password.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — Email::passwd_list — This function changes a mailing list's password.
cPanel API 2 — None.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$change_list_pass = $cpanel->api1('Email', 'passwdlist', array('mylist', '12345luggage') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $change_list_pass = $cpliveapi->api1('Email', 'passwdlist', ['mylist', '12345luggage'] ); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Email::passwdlist( $FORM('list','password') )">

Command Line

cpapi1 --user=username Email passwdlist list=mylist password=12345luggage

Notes:

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

Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
list	string	Required The mailing list name.	A valid mailing list name.	mylist
password	string	Required The new mailing list password.	A secure password string.	12345luggage

Parameter

Type

Description

Possible values

Example

list

string

Required

The mailing list name.

A valid mailing list name.

mylist

password

string

Required

The new mailing list password.

A secure password string.

12345luggage

Returns

This function does not return output.

Knowledgebase

Categories

Categories