v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
WebmailApps
Webmail Applications

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.

get/WebmailApps/list_webmail_apps

Query parameters

themestring
Example:jupiter

The webmail theme.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "list_webmail_apps",
  "module": "WebmailApps",
  "result": {
    "data": [
      {
        "displayname": "Roundcube",
        "icon": "/webmail/jupiter/images/roundcube_logo.png",
        "id": "roundcube",
        "url": "/cpsess##########/3rdparty/roundcube/index.php"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}