- Created by Documentation, last modified on Apr 09, 2018
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:
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
rootuser. - You must use the appropriate WHM ports (
2086or2087) to call WHM API functions.
Related Documentation
-
Page:Guide to cPanel API 1 — cPanel API 1 accesses information from the cPanel interface.
-
Page:Guide to cPanel API 2 — cPanel API 2 accesses cPanel account information and modifies settings.
-
Page:Guide to WHM API 0 — WHM API 0 accesses the WHM interface's features.
-
Page:Guide to UAPI — UAPI accesses the cPanel interface's features.
-
Page:Guide to the Manage2 API — The Manage2 API automates cPanel license management procedures.