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

Description

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

Note:

The generated password expires after one use. 

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive and MailSend roles, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/generate_mailman_otp?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.
 
// Generate a temporary password for the mylist mailing list.
$temp_passwd = $cpanel->uapi(
    'Email', 'generate_mailman_otp',
    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.
 
# Generate a temporary password for the mylist mailing list.
my $temp_passwd = $cpliveapi->uapi(
    'Email', 'generate_mailman_otp',
    {
        'list'        => 'mylist',
    }
);


Note:

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

 

 cPanel Template Toolkit
<!-- Generate a temporary password for the mylist mailing list. -->
[% execute('Email', 'generate_mailman_otp', { 'list' => 'mylist', }) %]


Note:

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

 

 Command Line
uapi --user=username Email generate_mailman_otp 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": "LfFYLPRT_UoS4EDi9lGKuOFK8FaWQsozzPYn8WjM3"
  "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
datastring

The new one-time password.

A secure generated password.

LfFYLPRT_UoS4EDi9lGKuOFK8FaWQsozzPYn8WjM3