Skip to content
Skip to breadcrumbs
Skip to header menu
Skip to action menu
Skip to quick search

We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Skip to end of banner Go to start of banner

WHM API 0 Sections - Mail

Skip to end of metadata

Created by Documentation, last modified on Mar 27, 2020

Go to start of metadata

Guide to WHM API 0

Accounts

DNS

removezonerecord

IP Addresses

Mail

deliver_mail_queue

deliver_messages_mail_queue

exim_configuration_check

purge_mail_queue

remove_in_progress_exim_config_edit

remove_messages_mail_queue

unfreeze_messages_mail_queue

validate_current_installed_exim_config

validate_exim_configuration_syntax

Packages

Resellers

setresellerlimits

setresellermainip

setresellernameservers

setresellerpackagelimit

suspendreseller

terminatereseller

unsetupreseller

unsuspendreseller

Server Administration

configureservice

SSL

Updates

get_available_tiers

set_cpanel_updates

Introduction

Mail functions allow you to manage your server's mail configurations.

Available functions

WHM API 0 Functions - deliver_mail_queue — This function delivers all messages in the server's mail queue.
WHM API 0 Functions - deliver_messages_mail_queue — This function delivers all messages in the server's mail queue.
WHM API 0 Functions - exim_configuration_check — This function scans the Exim configuration file for errors, and, if it finds any, attempts to repair them.
WHM API 0 Functions - fetch_doc_key — This function is for internal use only.
WHM API 0 Functions - purge_mail_queue — This function purges the mail server's queue.
WHM API 0 Functions - remove_in_progress_exim_config_edit — This function reverts a currently-in-progress Exim configuration edit.
WHM API 0 Functions - remove_messages_mail_queue — This function removes messages from the mail server's queue.
WHM API 0 Functions - unfreeze_messages_mail_queue — This function unfreezes messages from the mail server's queue.
WHM API 0 Functions - validate_current_installed_exim_config — This function validates the system's current Exim configuration.
WHM API 0 Functions - validate_exim_configuration_syntax — This function evaluates and validates an Exim configuration file's syntax.

WHM API 0 Basics

Available in:

WHM 11+

Languages:

XML or JSON API

Methods:

GET, POST

Return Formats:

JSON, XML

Page not found for multiexcerpt macro. The page: SDK:_XMLDeprecated was not found. Please check/update the page name used in the 'multiexcerpt-include macro.

About WHM API 0

WHM API 0 performs functions and accesses data in WHM.

Warning:

WHM API 0 is deprecated. We strongly recommend that you use the equivalent WHM API 1 function instead.

Notes:

Some functions and parameters may require that you authenticate as the root user.
You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Related Documentation

Page:

Guide to the Manage2 API — The Manage2 API automates cPanel license management procedures.
Page:

Guide to cPanel API 2 — cPanel API 2 accesses cPanel account information and modifies settings.
Page:

Guide to cPanel API 1 — cPanel API 1 accesses information from the cPanel interface.
Page:

Guide to WHM API 0 — WHM API 0 accesses the WHM interface's features.
Page:

Use WHM API to Call cPanel API and UAPI — You can call cPanel API and UAPI functions through the WHM API.