Description

This function checks a domain's mail exchanger type.

 For more information about MX record settings, read our Edit MX Entry documentation.

This function only checks the mail exchanger's cPanel configuration. It does not check DNS records. 


Examples 




https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=getalwaysaccept&domain="example.com"



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



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', 'getalwaysaccept',
    { 
        'domain'                => 'example.com', 
    }
);




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

 



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



Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

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

ReturnTypeDescriptionPossible valuesExample
domainstringThe domain name.

A valid domain on the cPanel account.

example.com

mxcheck

string

The mail exchanger type.

  • auto
  • local
  • secondary
  • remote
auto
alwaysacceptBooleanWhether the domain accepts local mail.
  • 1 — Accepts local mail.
  • 0 — Does not accept local mail.
1
reasonstring

A reason for failure.

This function only returns a reason value if it failed. 


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