Description
This function checks whether Domain Keys Identified Mail (DKIM) is enabled.
Examples
WHM API (JSON)
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=get_email_signing
LiveAPI PHP Class
$cpanel = new CPANEL();
$is_dkim_enabled = $cpanel->api2(
'Email', 'get_email_signing'
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $is_dkim_enabled = $cpliveapi->api2(
'Email', 'get_email_signing',
);
cPanel Tag System (deprecated)
Warning:
In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only 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 Email get_email_signing
|
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "get_email_signing",
"data": [
"dkim_available",
1,
"dkim",
1
],
"event": {
"result": 1
},
"module": "Email"
}
}
Parameters
This function does not accept parameters.
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
dkim_available
|
Boolean
|
Whether Exim supports DKIM on this server.
|
- 1 — Supported.
- 0 — Notsupported.
|
1
|
|
dkim
|
Boolean
|
Whether DKIM is enabled for the cPanel account.
|
- 1 — Enabled.
- 0 — Disabled.
|
1
|
|
reason
|
string
|
A reason for failure.
Note:
This function only returns areason value if it failed.
|
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
|
