cPanel API 2 Functions - Contactus::isenabled - Knowledgebase

Description

This function checks whether the account's contact option is enabled.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Contactus::is_enabled — This function checks whether the account's contact option is enabled.

Examples

WHM API (JSON)

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

LiveAPI PHP Class

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

// Determine whether contact option is enabled on account

$contact_enabled = $cpanel->api2(

'Contactus', 'isenabled'

);

LiveAPI Perl Module

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

# Determine whether contact option is enabled on account

my $contact_enabled = $cpliveapi->api2(

'Contactus', 'isenabled'

);

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "isenabled",
    "data": [
      {
        "enabled": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Contactus"
  }
}
 

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

Return	Type	Description	Possible Values	Example
enabled	boolean	Whether the contact option is enabled.	1 — The contact option is enabled. 0 — The contact option is disabled.	1
reason	string	A reason for failure. Note: This function only returns a reasonvalue 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