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

Description

This function returns an account's raw SPF record.


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

Examples 


 WHM API (JSON)
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=username&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=SPFUI&cpanel_jsonapi_func=get_raw_record&user=username


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.
 
// Return raw SPF record for example.com.
$get_raw_record = $cpanel->api2(
    'SPFUI', 'get_raw_record', 
		array(
		'user'			=> 'username'
	 ) 
);


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.
 
# Return raw SPF record for example.com.
my $get_raw_record = $cpliveapi->api2(
    'SPFUI', 'get_raw_record',
		{
		'user'			=> 'username'
		}
 );


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


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": "get_raw_record",
    "data": [
      {
        "record": "v=spf1 +a +mx +ip4:10.1.100.35 +ip6:2001:db8:1a34:56cf::/64" 
      }
    ],
    "event": {
      "result": 1
    },
    "module": "SPFUI"
  }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

The account's username.

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

The cPanel account username.
username

 

Returns

ReturnTypeDescriptionPossible valuesExample
recordstringThe account's raw SPF record.

An SPF record.

Note:

In cPanel & WHM version 54 and later, this value may contain IPv6 addresses.

 Click to view...
v=spf1 +a +mx +ip4:10.1.100.35 +ip6:2001:db8:1a34:56cf::/64
reasonstring

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.
resultBoolean

Whether the function succeeded.

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