cPanel API 2 Functions - Encoding::guess_file_opts - Knowledgebase

Knowledgebase

Description

This function retrieves a file's encoding and a list of all cPanel-supported character encodings.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Encoding&cpanel_jsonapi_func=guess_file_opts&file=public_html/index.html

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Retrieve encoding for the passwd file.
$get_encodings = $cpanel->api2(
    'Encoding', 'guess_file_opts',
        array (
            'file'              => 'public_html/index.html',
 
    )
);

LiveAPI Perl Module

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

# Retrieve encoding for the passwd file.

my $get_encodings = $cpliveapi->api2(

'Encoding', 'guess_file_opts'

array {

'file' => 'public_html/index.html',

);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly 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.

Knowledgebase

Categories

Categories