cPanel API 2 Functions - SPFUI::install - Knowledgebase

Description

This function installs Sender Policy Framework (SPF).

Warning:

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

Note:

On servers that run CentOS 7, you may see a named warning about the absence of SPF resource records on DNS.

This warning is not relevant on CentOS 7 servers, because RFC 7208 deprecated SPF records. CentOS 7 servers use TXT records instead of SPF records.
Red Hat 7.1 and CentOS 7.1 both contain bind-9.9.4-23.el7, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=SPFUI&cpanel_jsonapi_func=install&user=user

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Install SPF for example.com.
$install_spf = $cpanel->api2(
    'SPFUI', 'install',
        array(
        'user'          => 'user'
     )
);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Return raw SPF record for example.com.
my $install_spf = $cpliveapi->api2(
    'SPFUI', 'install',
        {
        'user'          => 'user'
        }
 );

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use theLiveAPI 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 ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "install",
    "data": [
      {
        "installed": "SPF has been enabled."
      }
    ],
    "event": {
      "result": 1
    },
    "module": "SPFUI"
  }
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
user	string	The account's username.	Any valid username.	user

Returns

Return	Type	Description	Possible values	Example
installed	string	Whether SPF installed.	SPF has been enabled. SPF not enabled.	SPF has been enabled.
reason	string	A reason for failure. Note: This function only returns a reason value if an error occurred.	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