Child pages
  • cPanel API 1 Functions - Email::addmx
Skip to end of metadata
Go to start of metadata

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:

Important:

In cPanel & WHM version 76 and later, when you disable the DNS role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

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.


Note:

For more information, read our Guide to the LiveAPI System.

 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.


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. 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 example.com mail.example.com 15 1


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (none)

This function does not return output.

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain name.

A valid domain on the server.

example.com
exchangestring

Required

The new mail exchanger's name.

A string in name.example.com format, where example.com represents the domain name.mail.example.com
preferenceinteger

Required

The mail exchanger's priority.

For more information about priority levels, read our Edit MX Entry documentation.

An integer value.

Note:

Generally, server owners set a priority value that is divisible by five.

15
alwaysacceptBoolean

Whether the mail exchanger accepts mail for its domain.

This parameter defaults to 1.

  • 1 — Accept mail for the domain, and add the domain to the /etc/localdomains file.
  • 0 — Do not accept mail for the domain, and add the domain to the /etc/remotedomains file.
1

Returns

This function does not return output.