Page History

Include Page

	LIB:_cPanelAPI1Menu
	LIB:_cPanelAPI1Menu

Description

Excerpt
This function deletes a mail exchanger.

Warning

title	Warning:

Include Page

	LIB:_cPanelAPI1NewerFunctions
	LIB:_cPanelAPI1NewerFunctions

UAPI (recommended) — Email::delete_mx —
Excerpt Include
DD:UAPI Functions - Email::delete_mxDD:
UAPI Functions - Email::delete_mx
nopanel true
cPanel API 2 — Email::delmx —
Excerpt Include
DD:cPanel API 2 Functions - Email::delmxDD:
cPanel API 2 Functions - Email::delmx
nopanel true

Multiexcerpt include

SpaceWithExcerpt	com.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptName	APIDisabledDNSRole
PageWithExcerpt	LIB:_ServerRoleDisabledAPI

Panel

bgColor	#F2F2F2
borderStyle	none

Examples

Panel

bgColor	#FFFFFF
borderStyle	none

Expand

title	LiveAPI PHP Class

Code Block

language	php
linenumbers	true

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

Include Page

	LIB:_LiveAPIPHPLink
	LIB:_LiveAPIPHPLink

Expand

title	LiveAPI Perl Module

Code Block

language	perl
linenumbers	true

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $del_mx = $cpliveapi->api1('Email', 'delmx', ['example.com', 'mail.example.com', '15'] ); # Call the function.

Include Page

	LIB:_LiveAPIPerlLink
	LIB:_LiveAPIPerlLink

Expand

title	cPanel Tag System (deprecated)

Include Page

	LIB:_cPanelTagsWarning
	LIB:_cPanelTagsWarning

Code Block

language	text

<cpanel Module="Email::delmx( $FORM('domain','exchange','preference') )">

Expand

title	Command Line

Code Block

language	bash

cpapi1 --user=username Email delmx example.com mail.example.com 15

Include Page

	LIB:_cPanelAPI1CLINote
	LIB:_cPanelAPI1CLINote

Expand

title	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 mail exchanger's name.

The mail exchanger's name in name.example.com format, where example.com represents the domain name.

mail.example.com

preference

integer

Required

The mail exchanger's priority.

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

Note

title	Note:

If multiple MX entries match the exchange value, the system uses this parameter to find the correct entry.

An integer value.

Note

title	Note:

It is common practice to set a priority value that you can divide by five.

15

Returns

This function does not return output.

Panel

bgColor	#F2F2F2
borderStyle	none

Function information

Panel

bgColor	#FFFFFF
borderStyle	none

Section

Column

width	40%

Module:

Column
`Email`

Section

Column

width	40%

API Version:

Column
cPanel API 1

Section

Column

width	40%

Available in:

Column
cPanel 11+

Section

Column

width	40%

Methods:

Column
GET, POST

Section

Column

width	40%

Required Parameters:

Column
`domain`, `exchange,` `preference`

Section

Column

width	40%

Return Formats:

Column
(none)

About this module

The Email module modifies cPanel email account settings.

About cPanel API 1

Include Page

	LIB:_cPanelAPI1About
	LIB:_cPanelAPI1About

Find a function

Livesearch

additional	page excerpt
placeholder	Search...
labels	cpanelapi1

Related functions

Content by Label

showLabels	false
max	5
showSpace	false
sort	modified
excerpt	true
excerptType	simple
operator	AND
cql	label = "cpanelapi1" and label = "email"
labels	cpanelapi1,email

Child pages

Versions Compared

Old Version 9

New Version Current

Key

Description

Examples

Parameters

Returns

Function information

About this module

About cPanel API 1

Find a function

Related functions