v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Email
Email Accounts

Return email accounts

This function lists the cPanel account's email accounts.

Important:

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

get/Email/list_pops

Query parameters

no_validate0 | 1
Example:1

Whether to skip the email database's validation check.

  • 1 — Skip the validation check.
  • 0 — Run the validation check.
regexstring
Example:user

A Perl Compatible Regular Expression (PCRE) that filters the results.

skip_main0 | 1

Whether to exclude the cPanel account's main account from the results.

  • 1 — Exclude the main account.
  • 0 — Include the main account.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "list_pops",
  "module": "Email",
  "result": {
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}