cPanel API 2 Functions - Email::getmxcheck

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

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

Warning:

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

Important:

When you disable the Receive Mail role, the system disables this function.

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="example.com"

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.

// Check example.com's mail exchange type.
$check_mx_type = $cpanel->api2(
    'Email', 'getmxcheck',
    array(
        'domain'                => 'example.com',
    )
);

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.

# Update settings for mail.example.com.
my $check_mx_type = $cpliveapi->api2(
    'Email', 'getmxcheck',
    {
        'domain'                => 'example.com',
    }
);

Note:

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

cPanel Tag System (deprecated)

Warnings:

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 Email getmxcheck domain=example.com

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": "getmxcheck",
    "data": [
      {
        "domain": "example.com",
        "mxcheck": "auto",
        "alwaysaccept": 0
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Note:

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

Parameters

Parameter Type Description Possible values Example

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`

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 a `reason` 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`