Child pages
  • cPanel API 1 Functions - Email::changemx

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function modifies a mail exchanger's settings.


Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended) Email::change_mx
    Excerpt Include
    DD:UAPI Functions - Email::change_mxDD:
    UAPI Functions - Email::change_mx
    nopaneltrue
  • cPanel API 2 Email::changemx
    Excerpt Include
    DD:cPanel API 2 Functions - Email::changemxDD:
    cPanel API 2 Functions - Email::changemx
    nopaneltrue

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledDNSRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink
 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Email::changemx( $FORM('domain','exchange','preference','alwaysaccept','oldexchange','oldpreference') )">



Expand
titleCommand Line


Code Block
cpapi1 --user=username Email changemx example.com mail.example.com 15 local mail.example.com 45

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (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
titleNote:

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.