cPanel API 1 Functions - Email::setmxaccept

Description

This function sets a mail exchanger's role.

Note:

This function only affects the mail exchanger's configuration in cPanel. You must also modify the mail exchanger's DNS entry. 

Warning:

cPanel API 1 is deprecatedDo not use this function. Instead, we strongly recommend that you use the following newer functions:

Examples 


 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$set_mx_mxcheck = $cpanel->api1('Email', 'setmxaccept', array('example.com', 'local') ); // Call the function.

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $set_mx_mxcheck = $cpliveapi->api1('Email', 'setmxaccept', ['example.com', 'local'] ); # Call the function.

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

 

<cpanel Module="Email::setmxaccept( $FORM('domain','mxcheck') )">

 Command Line

cpapi1 --user=username Email setmxaccept domain=example.com mxcheck=local

 

Notes:

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

 Output (none)

This function does not return output.
 

Parameters

 Parameter 

Type

Description

Possible values

Example

 domain

 string 

 Required

 The domain name.

 A valid domain on the server.

 example.com 

 mxcheck

 string 

 Required

 The mail exchanger's role. 

  • auto — Use a DNS query to determine the appropriate role.
  • local — Always accept and route mail.
  • secondary — Accept mail if a higher-priority mail server is not available.
  • remote — Never accept mail for the domain.

 local

 

Returns

This function does not return output.

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....