cPanel API 1 Functions - Email::delmx - Knowledgebase

Description

This function deletes a mail exchanger.

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::delete_mx — This function deletes a Mail Exchanger (MX) record.
cPanel API 2 — Email::delmx — This function deletes a mail exchanger.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

$del_mx = $cpanel->api1('Email', 'delmx', array('example.com', 'mail.example.com', '15') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

my $del_mx = $cpliveapi->api1('Email', 'delmx', ['example.com', 'mail.example.com', '15'] ); # 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::delmx( $FORM('domain','exchange','preference') )">

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
exchange	string	Required The mail exchanger's name.	The mail exchanger's name inname.example.com format, whereexample.com is the domain name.	mail.example.com
preference	integer	The mail exchanger's priority. For more information about priority levels, read our Edit MX Entry documentation.	An integer value. Note: It is common practice to set a priority value that is divisible by five.	15

Returns

This function does not return output.

Knowledgebase

Categories

Categories