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

Description

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.

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/list_pops_for?api.version=1&user=example
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/list_pops_for?api.version=1&user=example
 Command Line
whmapi1 list_pops_for user=example


Notes:

  • 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:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
 {
    "data": {
        "pops": [
            "example1@example.com",
            "example3@example.com",
            "example2@example.com"
        ]
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": "1",
        "command": "list_pops_for"
    }
}
 Output (XML)
 <result>
    <data>
        <pops>example1@example.com</pops>
        <pops>example3@example.com</pops>
        <pops>example2@example.com</pops>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>list_pops_for</command>
    </metadata>
</result>


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
user string

Required

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

A cPanel account username. example

Returns

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

example1@example.com