Child pages
  • cPanel API 2 Functions - Email::set_email_signing
Skip to end of metadata
Go to start of metadata

 

Description

This function enables or disables DKIM.


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=Email&cpanel_jsonapi_func=set_email_signing&dkim=1


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Enable DKIM on the cPanel account.
$enable_dkim = $cpanel->api2(
    'Email', 'set_email_signing', 
    array(
        'dkim'            => '1',
    ) 
);


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.
 
# Enable DKIM on the cPanel account.
my $enable_dkim = $cpliveapi->api2(
    'Email', 'set_email_signing',
    {
        'dkim'            => '1',
    } 
);


Note:

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

 

 cPanel Tag System (deprecated)


Warnings:

  • 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. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 Command Line
cpapi2 --user=username Email set_email_signing dkim=1


Notes:

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

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "set_email_signing",
    "data": [
      1,
      "DKIM signing enabled"
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
dkimBoolean

Required

The new DKIM setting.

  • 1, y, yes, or on — Enable DKIM.
  • 0, n, no, or off — Disable DKIM.
1

Returns

ReturnTypeDescriptionPossible valuesExample
[0]BooleanWhether DKIM is enabled for the cPanel account.
  • 1 — Enabled.
  • 0 — Disabled.
1
[1]stringA message of success or a reason for failure.
  • DKIM signing enabled — DKIM is now enabled.
  • DKIM signing disabled — DKIM is now disabled.
  • An error message.
DKIM signing enabled
reasonstring

A reason for failure.

Note:

This function only returns a reason value if it failed. 

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1