We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Description

This function modifies a Mailman mailing list's privacy options.

Important:

In cPanel & WHM version 76 and later, when you disable the Receive Mail role, the system disables this function.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/set_list_privacy_options?list=mylist&advertised=1&archive_private=1&subscribe_policy=1


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.
 
// Update mailing list privacy settings.
$privacy_settings = $cpanel->uapi(
    'Email', 'set_list_privacy_options',
    array(
        'list'                => 'mylist',
        'advertised'          => '1',
        'archive_private'     => '1',
        'subscribe_policy'    => '1',
         )
);


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.
 
# Update mailing list privacy settings.
my $privacy_settings = $cpliveapi->uapi(
    'Email', 'set_list_privacy_options',
    {
        'list'                => 'mylist',
        'advertised'          => '1',
        'archive_private'     => '1',
        'subscribe_policy'    => '1',
    }
);


Note:

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


 Command Line
uapi --user=username Email set_list_privacy_options list=mylist advertised=1 archive_private=1 subscribe_policy=1


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": 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 name.

A valid mailing list name.

mylist
advertisedBoolean

Required

Whether the Mailman directory page displays the list.

  • 1 — Displays.
  • 0 — Does not display.
1
archive_privateBoolean

Required

Whether the mailing list archive is private.

  • 1 — Private.
  • 0 — Public.
1
subscribe_policyinteger

Required

The level of control that the mailing list administrator has over new subscribers.

  • 1 — Anyone can subscribe. The system sends a confirmation email.
  • 2 — The administrator must approve subscriptions. The system does not send a confirmation email.
  • 3 — The administrator must approve subscriptions. The system sends a confirmation email.
1

Returns

This function only returns metadata.