Page tree
Skip to end of metadata
Go to start of metadata

Description

This function creates a Mail Exchanger (MX) record. For more information about MX record settings, read our Edit MX Entry documentation. 

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/add_mx?domain=example.com&exchanger=mail.example.com&priority=5&alwaysaccept=1

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Create the mail.example.com MX record.
$new_mx = $cpanel->uapi(
    'Email', 'add_mx',
    array(
        'domain'        => 'example.com',
        'exchanger'     => 'mail.example.com',
        'priority'    => '5',
        'alwaysaccept'  => '1',
         )
);

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.
 
# Create the mail.example.com MX record.
my $new_mx = $cpliveapi->uapi(
    'Email', 'add_mx',
    {
        'domain'        => 'example.com',
        'exchanger'     => 'mail.example.com',
        'priority'    => '5',
        'alwaysaccept'  => '1',
    }
);

Note:

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

 

 cPanel Template Toolkit
<!-- Create the mail.example.com MX record, then display the changed value. -->
[% data = execute( 'Email', 'add_mx', { 'domain' => 'example.com', 'exchanger' => 'mail.example.com', 'priority' => '5', 'alwaysaccept' => '1', } ); %]
[% FOREACH q = data.checkmx.changed %]
     <p>
         [% q %]
     </p>
[% END %]
 
<!-- Get only the changed value. -->
[% execute('Email', 'add_mx', { 'domain' => 'example.com', 'exchanger' => 'mail.example.com', 'priority' => '5', 'alwaysaccept' => '1', } ).data.checkmx.changed %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Email add_mx domain=example.com exchanger=mail.example.com priority=5 alwaysaccept=1

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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "data":{  
      "statusmsg":"Added entry:\nBind reloading on example using rndc zone: [example.com]\n",
      "checkmx":{  
         "warnings":[ 
         ],
         "issecondary":0,
         "local":1,
         "remote":0,
         "detected":"local",
         "isprimary":1,
         "changed":0,
         "mxcheck":"auto",
         "secondary":0,
         "status":1,
         "results":"Added entry:\nBind reloading on example using rndc zone: [example.com]\n"
      }
   }
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The new mail exchanger's domain.

A valid domain on the account.

example.com
exchangerstring

Required

The new mail exchanger's name.

A valid mail exchanger name.

mail.example.com
priorityinteger

Required

The new mail exchanger's priority value.

A positive integer.

Note:

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

5
alwaysacceptBoolean

Whether the mail exchanger accepts all mail for the domain.

This value defaults to 0.

  • 1 — The mail exchanger always accepts mail.
  • 0 — The mail exchanger does not always accept mail.
1

Returns

ReturnTypeDescriptionPossible valuesExample
statusmsgstringA message of success, or an error message.
  • A message of success that begins with Added entry:.
  • An error message.
 Click to view...
Added entry:\nBind reloading on example using rndc zone: [example.com]\n
checkmxhashA hash of the mail exchanger's data.This hash includes the warnings, issecondary, local, detected, remote, isprimary, changed, secondary, and mxcheck returns. 

warnings

array

Warning messages, if any exist.

The function returns this value in the checkmx hash.

One or more warning messages.
 Click to view...
Auto Detect of MX configuration not possible due to non-resolving MX entries.  Defaulting to last known setting: local.

issecondary

Boolean

Whether the mail exchanger is a secondary exchanger.

The function returns this value in the checkmx hash.

  • 1 — Secondary.
  • 0Not secondary.

0

local

Boolean

Whether the mail exchanger is a local exchanger.

The function returns this value in the checkmx hash.

  • 1 — Local.
  • 0Not local.
0

detected

string

The mail exchanger type.

The function returns this value in the checkmx hash.

  • auto
  • local
  • secondary
  • remote
auto

remote

Boolean

Whether the mail exchanger is a remote exchanger.

The function returns this value in the checkmx hash.

  • 1 — Remote.
  • 0Not remote.
0

isprimary

Boolean

Whether the mail exchanger is the primary mail exchanger.

The function returns this value in the checkmx hash.

  • 1 — Primary.
  • 0Not primary.
0

changed

Boolean

Whether a change occurred during the function.

The function returns this value in the checkmx hash.

  • 1 — Change occurred.
  • 0No change.
1

secondary

Boolean

Whether the mail exchanger is a secondary exchanger.

The function returns this value in the checkmx hash.

  • 1 — Secondary.
  • 0Not secondary.

0

mxcheck

string

The mail exchanger type.

The function returns this value in the checkmx hash.

  • auto
  • local
  • secondary
  • remote
auto
statusBooleanWhether the function succeeded.
  • 1 — Success.
  • 0 — Failure.
1
resultsstringA message of success, or an error message.
  • A message of success that begins with Added entry:.
  • An error message.
 Click to view...
Added entry:\nBind reloading on example using rndc zone: [example.com]\n