Child pages
  • UAPI Functions - Contactus::is_enabled
Skip to end of metadata
Go to start of metadata

 

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


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

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


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.
 
# Check whether the account's contact option is enabled.
my $check_contact_setting = $cpliveapi->uapi(
    'Contactus', 'is_enabled',
);


Note:

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

 cPanel Template Toolkit
<!-- Check whether the account's contact option is enabled. -->
[% execute( 'Contactus', 'is_enabled' ); %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username Contactus is_enabled


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": {
    "enabled": 1
  }
}


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

ReturnTypeDescriptionPossible valuesExample
enabledBoolean

Whether the account's contact option is enabled.

  • 1 — Enabled.

  • 0 — Disabled.

1