cPanel API 2 Functions - Encoding::guess_file

Description

This function attempts to retrieve a file's character encoding.

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&file=home%2Fuser%2Fetc%2Fexample%2Fpublic_html/index.html=

 LiveAPI PHP Class

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

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Uninstall DomainKeys on example.com.
my $get_encodings $cpliveapi->api2(
    'Encoding''guess_file'
        {
        'file'              => '/home/user/etc/example/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.

 

 Command Line

cpapi2 --user=username Encoding guess_file file=%2Fhome%2Fuser%2Fetc%2Fexample%2Fpublic_html%2Findex.html

 

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "guess_file",
    "data": [
      {
        "file": /home/user/etc/example/passwd,
        "encoding": "us-ascii"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Encoding"
  }
}

 

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

 Parameter 

 Type 

 Description 

Possible values

Example

 file

 string 

 Required

 The file.

 A valid absolute file path. 

 /home/user/etc/example/public_html/index.html 

 

 

Returns

Return

Type

Description

Possible values

Example

 encoding 

 string

 The file's character encoding.

 Any cPanel-known character encoding. 

 ansi_x3.110-1983

 file

 string

 The file's path.

 An absolute file path.

 /home/user/etc/example/passwd 

 reason

 string

 A reason for failure.

 Note:

 

 This function only returns areason value if there was an error. 

 

 

 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

 

  • 7 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....