Description
This function checks the installation status of 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
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. |
The cPanel account's username. |
user |
Returns
Return |
Type |
Description |
Possible values |
Example |
installed |
boolean |
Whether SPF is installed. |
|
1 |
active |
boolean |
Whether SPF is active. |
|
0 |
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 |