Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function lists available themes.

Note:

In cPanel & WHM version 66 and later, the /scripts/modify_accounts script allows you to modify the style and theme for many or all accounts on the server. For more information, read our The modify_accounts Script documentation. 

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Themes/list?show_mail_themes=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.
 
// List themes for example.com.
$list_themes = $cpanel->uapi(
    'Themes', 'list',
		array(
		'show_mail_themes'			=> '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.
 
# Set list themes on example.com.
my $list_theme = $cpliveapi->uapi(
    'Themes', 'list',
	{
		'show_mail_themes'			=> '1',

	}
 );

Note:

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

 

 cPanel Template Toolkit
<!-- List the themes. -->
[% execute('Themes', 'list', { show_mail_themes => '1', } ); %]

Note:

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

 

 Command Line
uapi --user=username Themes list show_mail_themes=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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{  
   "messages":null,
   "metadata":{  
      "transformed":1
   },
   "data":[  
      "paper_lantern"
   ],
   "status":1,
   "errors":null
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
show_mail_themesstring

Whether to list the account's mail themes.

This parameter defaults to 0.

  • 1 — List mail themes.
  • 0 — Do not list mail themes.
1

Returns

ReturnTypeDescriptionPossible valuesExample
dataarray

An array that contains the account's themes.

One or more available themes.

paper_lantern