Child pages
  • cPanel API 2 Functions - WebmailApps::listwebmailapps
Skip to end of metadata
Go to start of metadata

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:
  • 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.

Important:

In cPanel & WHM version 76 and later, when you disable the Webmail role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

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


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$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.

 

 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',
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warnings:

  • 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. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • 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 documentation.

 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.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

 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 (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

ParameterTypeDescriptionPossible valuesExample
featurestringThe Webmail application's feature name.A valid string.horde
iconstringThe path to the Webmail application's icon file.A valid file path, relative to the home directory.
/webmail/x3mail/images/horde.gif
urlstringThe URL to the Webmail application's location.A valid URL, relative to the home directory.
/cpsess1658535621/horde/index.php?cpanel=1
idstringThe Webmail application's ID.A valid string.horde
displaynamestringThe Webmail application's display name.A valid string.
Horde
ifstring

The conditional statement that the interface uses to determine whether to display the Webmail application.

A conditional statement.

For more information, read this Stackoverflow article.

!$CONF{'skiphorde'}
reasonstring

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.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1