You can find our user documentation at

Check out our new API beta site!

Child pages
  • WHM API 1 Functions - list_pops_for
Skip to end of metadata
Go to start of metadata


This function lists a cPanel account’s email accounts. To prevent falsified data or symlink exploitation, the function uses the specified cPanel account user, rather than root user, to read data from the user’s home directory. The system compares the collected data from the user’s home directory to a server-wide domains list. The comparison of the data validates whether you can trust the data.


In cPanel & WHM version 76 and later, when you disable the Receive Mail role, the system disables this function.


 Command Line
whmapi1 list_pops_for user=example


  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:


 Output (JSON)
   "data": {
       "pops": [
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": "1",
        "command": "list_pops_for"
 Output (XML)


Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.


ParameterTypeDescriptionPossible valuesExample
user string


The cPanel account user for which to list all owned email accounts.

A cPanel account username. example


ReturnTypeDescriptionPossible valuesExample
pops arrayAn array of email accounts that the cPanel user owns.An array of email accounts.