cPanel API 2 Functions - WebmailApps::listwebmailapps - Knowledgebase

Description

This function retrieves information about an account's Webmail applications.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:
- Webmailapps::listwebmailapps — This function lists the account's available webmail clients.
We deprecated and removed this function in cPanel & WHM version 11.44. For help to update custom code that uses this function, send an email to integration@cpanel.net.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=WebmailApps&cpanel_jsonapi_func=listwebmailapps

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List Webmail applications

$list_webmail = $cpanel->api2(

'WebmailApps', 'listwebmailapps'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List Webmail applications

my $list_webmail = $cpliveapi->api2(

'WebmailApps', 'listwebmailapps',

);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

Because we removed this function before we introduced this functionality, you cannot call this function via the command line.

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listwebmailapps",
    "data": [
      {
        "feature": "horde",
        "icon": "/webmail/x3mail/images/horde.gif",
        "url": "/cpsess1658535621/horde/index.php?cpanel=1",
        "id": "horde",
        "displayname": "Horde",
        "if": "!$CONF{'skiphorde'}"
      },
      {
        "icon": "/webmail/x3mail/images/roundcube_logo.png",
        "url": "/cpsess1658535621/3rdparty/roundcube/index.php",
        "id": "roundcube",
        "displayname": "RoundCube",
        "if": "!$CONF{'skiproundcube'}"
      },
      {
        "feature": "sqmail",
        "icon": "/webmail/x3mail/images/squirrelmail_logo.gif",
        "url": "/cpsess1658535621/3rdparty/squirrelmail/index.php",
        "id": "sqmail",
        "displayname": "SquirrelMail",
        "if": "!$CONF{'skipsqmail'}"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "WebmailApps"
  }
}

Note:

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

Parameters

This function does not accept parameters.

Returns

Parameter	Type	Description	Possible values	Example
feature	string	The Webmail application's feature name.	A valid string.	horde
icon	string	The path to the Webmail application's icon file.	A valid file path, relative to the home directory.	/webmail/x3mail/images/horde.gif
url	string	The URL to the Webmail application's location.	A valid URL, relative to the home directory.	/cpsess1658535621/horde/index.php?cpanel=1
id	string	The Webmail application's ID.	A valid string.	horde
displayname	string	The Webmail application's display name.	A valid string.	Horde
if	string	The conditional statement that the interface uses to determine whether to display the Webmail application.	A conditional statement.	!$CONF{'skiphorde'}
reason	string	A reason for failure. Note: This function only returns a reason value if it failed.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories