cPanel API 2 Functions - Email::getmxcheck - Knowledgebase

Description

This function retrieves a domain's mail exchanger's type. For more information about MX record settings, read our Edit MX Entry documentation.

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=getmxcheck&domain=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Check example.com's mail exchange type.
$check_mx_type = $cpanel->api2(
    'Email', 'getmxcheck', 
    array(
        'domain'                => 'example.com', 
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Update settings for mail.example.com.
my $check_mx_type = $cpliveapi->api2(
    'Email', 'getmxcheck',
    {
        'domain'                => 'example.com',
    }
);

cPanel Tag System (deprecated)

Warning:

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.

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

Command Line

cpapi2 --user=username Email getmxcheck domain=example.com

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "getmxcheck",
    "data": [
      {
        "domain": "example.com",
        "mxcheck": "auto",
        "alwaysaccept": 0
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
domain	string	The domain. If you do not use this parameter, the function lists data for all of the account's domains.	A valid domain on the cPanel account.	example.com

Parameter

Type

Description

Possible values

Example

domain

string

The domain.

If you do not use this parameter, the function lists data for all of the account's domains.

A valid domain on the cPanel account.

example.com

Returns

Return	Type	Description	Possible values	Example
domain	string	The domain name.	A valid domain on the cPanel account.	example.com
mxcheck	string	The mail exchanger type.	auto local secondary remote	auto
alwaysaccept	Boolean	Whether the domain accepts local mail.	1 — Accepts local mail. 0 — Does not accept local mail.	1
reason	string	A reason for failure. Note: This function only returns areason value if it failed.	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