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

Description

This function modifies a mail exchanger's settings.

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.
$edit_mx = $cpanel->api1('Email', 'changemx', array('example.com', 'mail.example.com', '15', 'local', 'mail.example.com', '45') ); // 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 $edit_mx = $cpliveapi->api1('Email', 'changemx', ['example.com', 'mail.example.com', '15', 'local', 'mail.example.com', '45'] ); # 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::changemx( $FORM('domain','exchange','preference','alwaysaccept','oldexchange','oldpreference') )">
 Command Line
cpapi1 --user=username Email changemx example.com mail.example.com 15 local mail.example.com 45


Notes:

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

    /usr/local/cpanel/bin/uapi


 Output (none)

This function does not return output.

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain name.

The mail exchanger's domain.

example.com
exchangestring

Required

The mail exchanger's name.

The mail exchanger's name, in name.example.com format, where example.com is 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:

It is common practice to set a priority value that is divisible by five.

15
alwaysacceptstring

The mail exchanger's type.

If you do not specify a value, the system uses your current configuration to determine the best type to use.

  • local
  • secondary
  • backup
  • remote
local
oldexchangestring

The name of the mail exchanger to replace.

If you do not specify a value, the system creates a new mail exchanger.

The name of an existing mail exchanger on the server, in name.example.com format, where example.com is the domain name.mail.example.com
oldpreferenceinteger

The mail exchanger's previous priority value.

If the value for the oldexchange parameter matches multiple MX entries, the system uses this value to determine which MX entry to modify.

The mail exchanger's previous priority value.45

Returns

This function does not return output.