# cPanel API 2 Functions - WebmailApps::listwebmailapps

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

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

Warning:
We **strongly** recommend that you use the following [UAPI](/cpanel/introduction/) function instead of this function: - [`Webmailapps::list_webmail_apps`](https://api.docs.cpanel.net/openapi/cpanel/operation/list_webmail_apps/) — This function lists the account's available webmail clients.

Important:
When you disable the [*Webmail* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


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

// List Webmail applications
$list_webmail = $cpanel->api2(
    'WebmailApps', 'listwebmailapps'
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


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

# List Webmail applications
my $list_webmail = $cpliveapi->api2(
    'WebmailApps', 'listwebmailapps',
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system).
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username WebMailApps listwebmailapps
```

div
Notes:

- You **must** URI-encode values.
- `username` represents your account-level username.
- You **must** include the `--user=username` option.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

This function does not accept parameters.

## Returns

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