cPanel/WebmailApps
cPanel module

WebmailApps

1 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi
Call any function with cpanel_uapi(service_id, module="WebmailApps", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.

list_webmail_apps GET#

Return available webmail clients

This function lists the account's available webmail clients.

Important:

When you disable the Receive Mail role, the system disables this function.

themestringOptional
The webmail theme.

Response — normalized as { ok, data, errors[], warnings[] }; data is an array of:

displaynamestring
The webmail client name, as it will display in the interface.
iconstring
An icon file's path, relative to the /usr/local/cpanel/base/frontend directory.
idstring
The webmail client's ID.
urlstring
The webmail client's URL.