UAPI Functions - Contactus::is_enabled - Knowledgebase

Description

This function checks whether the account's contact option is enabled. The contact option allows cPanel account users to contact their hosting providers.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Contactus/is_enabled

LiveAPI PHP Class

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

// Check whether the account's contact option is enabled.

$check_contact_setting = $cpanel->uapi(

'Contactus', 'is_enabled'

);

LiveAPI Perl Module

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

# Check whether the account's contact option is enabled.

my $check_contact_setting = $cpliveapi->uapi(

'Contactus', 'is_enabled',

);

cPanel Template Toolkit

[% execute( 'Contactus', 'is_enabled' ); %]

Command Line

uapi --user=username Contactus is_enabled

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": {
    "enabled": 1
  }
}

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 account's contact option is enabled.	1 — Enabled. 0 — Disabled.	1

Knowledgebase

Categories

Categories