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


This function lists the account's SPF settings.


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


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. For more information, read the the Red Hat Bugzilla case about SPF record errors.




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

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
// List SPF settings for
$list_spf_settings = $cpanel->api2(
    'SPFUI', 'list_settings', 
		'user'			=> 'username'


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.
# List SPF settings for
my $list_spf_settings = $cpliveapi->api2(
    'SPFUI', 'list_settings',
		'user'			=> 'username'


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

 cPanel Tag System (deprecated)


  • 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 SPFUI list_settings user=username


  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
  "cpanelresult": {
    "apiversion": 2,
    "func": "list_settings",
    "data": [
        "opt": "All Entry (ALL)"
    "event": {
      "result": 1
    "module": "SPFUI"


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


ParameterTypeDescriptionPossible valuesExample

The account's username.

If you do not specify a value, this parameter defaults to the currently authenticated username.

The cPanel account username.



ReturnTypeDescriptionPossible valuesExample
optstringThe SPF settings that the account uses.A list of SPF settings.
All Entry (ALL)

A reason for failure.



 A string that describes the error. This is an error message.

Whether the function succeeded.

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