cPanel API 2 Functions - DKIMUI::available - Knowledgebase

Description

This function checks whether Domain Keys Identified Mail (DKIM) is available on a server.

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=DKIMUI&cpanel_jsonapi_func=available

LiveAPI PHP Class

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

// Check whether DKIM is available on example.com.

$dkim_available = $cpanel->api2(

'DKIMUI', 'available'

)

);

LiveAPI Perl Module

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

# Check whether DKIM is available on example.com.

my $dkim_available = $cpliveapi->api2(

'DKIMUI', 'available',

);

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 DKIMUI available

Notes:

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

Output (JSON)

{

"cpanelresult": {

"apiversion": 2,

"func": "available",

"data": [

{

"available": 1

}

],

"event": {

"result": 1

},

"module": "DKIMUI"

}

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
available	Boolean	Whether DKIM is available.	1 — Available. 0 — Unvailable.	1
reason	string	A reason for failure. Note: This function only returns a reason 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

Knowledgebase

Categories

Categories