UAPI Functions - Email::generate_mailman_otp - Knowledgebase

Description

This function generates a one-time password (OTP) for a mailing list.

Note:

The generated password expires after one use.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/generate_mailman_otp?list=mylist

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Generate a temporary password for the mylist mailing list.
$temp_passwd = $cpanel->uapi(
    'Email', 'generate_mailman_otp',
    array(
        'list'        => 'mylist',
         )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Generate a temporary password for the mylist mailing list.
my $temp_passwd = $cpliveapi->uapi(
    'Email', 'generate_mailman_otp',
    {
        'list'        => 'mylist',
    }
);

cPanel Template Toolkit

[% execute('Email', 'generate_mailman_otp', { 'list' => 'mylist', }) %]

Command Line

uapi --user=username Email generate_mailman_otp list=mylist

Notes:

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

 Output (JSON)

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

Parameter

Type

Description

Possible values

Example

list

string

Required

The mailing list.

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

mylist

Returns

Return	Type	Description	Possible values	Example
data	string	The new one-time password.	A secure generated password.	LfFYLPRT_UoS4EDi9lGKuOFK8FaWQsozzPYn8WjM3

Knowledgebase

Categories

Categories