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.

SecurityBasicAuth

Request

query Parameters

theme

string

Default: "the server's default theme"

The webmail theme.

Example: theme=jupiter

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/WebmailApps/list_webmail_apps

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  WebmailApps \
  list_webmail_apps

Response samples

application/json

{"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"
}
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}