Description
This function modifies a Mailman mailing list's privacy options.
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
LiveAPI PHP Class
$cpanel = new CPANEL();
$privacy_settings = $cpanel->uapi(
'Email', 'set_list_privacy_options',
array(
'list' => 'mylist',
'advertised' => '1',
'archive_private' => '1',
'subscribe_policy' => '1',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $privacy_settings = $cpliveapi->uapi(
'Email', 'set_list_privacy_options',
{
'list' => 'mylist',
'advertised' => '1',
'archive_private' => '1',
'subscribe_policy' => '1',
}
);
cPanel Template Toolkit
[% execute('Email', 'set_list_privacy_options', { 'list' => 'mylist', 'advertised' => '1', 'archive_private' => '1', 'subscribe_policy' => '1', }) %]
Command Line
uapi --user=username Email set_list_privacy_options list=mylist advertised=1 archive_private=1 subscribe_policy=1
|
Output (JSON)
{
"messages": null,
"errors": null,
"status": 1,
"data": null,
"metadata": {
"transformed": 1
}
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
list
|
string
|
Required
The mailing list name.
|
A valid mailing list name.
|
mylist
|
|
advertised
|
Boolean
|
Required
Whether the Mailman directory page displays the list.
|
- 1 — Displays.
- 0 — Does not display.
|
1
|
|
archive_private
|
Boolean
|
Required
Whether the mailing list archive is private.
|
|
1
|
|
subscribe_policy
|
integer
|
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.
