cPanel API 1 Functions - Email::setmxaccept - Knowledgebase

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 deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — Email::set_always_accept — This function sets the Mail Exchanger (MX) type.
cPanel API 2 — Email::setalwaysaccept — This function modifies a mail exchanger's type.

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

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.

Knowledgebase

Categories

Categories