latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Mail
cPanel Account Mail Management

Return cPanel account's email accounts

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:

When you disable the Receive Mail role, the system disables this function.

get/list_pops_for

Query parameters

userstring required
Example:example

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

Response

HTTP Request was successful.

Example response

{
  "data": {
    "pops": [
      "example1@example.com"
    ]
  },
  "metadata": {
    "command": "list_pops_for",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}