Child pages
  • UAPI Functions - Themes::list

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt
This function lists available themes.

Note
titleNote:

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. 

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titlecPanel or Webmail Session URL
Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/Themes/list?show_mail_themes=1

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$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',
	)
 );

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
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',

	}
 );

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Template Toolkit
Code Block
languagexml
linenumberstrue
<!-- List the themes. -->
[% execute('Themes', 'list', { show_mail_themes => '1', } ); %]

Include Page
LIB:_TTLink
LIB:_TTLink

 

Expand
titleCommand Line
Code Block
languagebash
uapi --user=username Themes list show_mail_themes=1

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{  
   "messages":null,
   "metadata":{  
      "transformed":1
   },
   "data":[  
      "paper_lantern"
   ],
   "status":1,
   "errors":null
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

   

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