cPanel API 1 Functions - Email::addmx - Knowledgebase

Description

This function adds an MX entry to a domain's DNS zone file.

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::add_mx — This function creates a Mail Exchanger (MX) record.
cPanel API 2 — Email::addmx — This function creates an MX record.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$new_mx = $cpanel->api1('Email', 'addmx', array('example.com', 'mail.example.com', '15', '1') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $new_mx = $cpliveapi->api1('Email', 'addmx', ['example.com', 'mail.example.com', '15', '1'] ); # 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::addmx( $FORM('domain','exchange','preference','alwaysaccept') )">

Command Line

cpapi1 --user=username Email addmx domain=example.com exchange=mail.example.com preference=15 alwaysaccept=1

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 new mail exchanger's name.	A string in `name.example.com` format, where `example.com` represents the domain name.	`mail.example.com`
`preference`	integer	Required The mail exchanger's priority.	An integer value. Note: Generally, server owners set a priority value that is divisible by five.	`15`

Returns

This function does not return output.

Knowledgebase

Categories

Categories