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.

Authorizations:
query Parameters
no_validate
integer
Default: 0

Whether to skip the email database's validation check.

  • 1 — Skip the validation check.
  • 0 — Run the validation check.
Enum: 0 1
Example: no_validate=1
regex
string

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

Example: regex=user
skip_main
integer
Default: 0

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

  • 1 — Exclude the main account.
  • 0 — Include the main account.
Enum: 0 1
Example: skip_main=0

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --user=username Email list_pops

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "list_pops",
  • "module": "Email",
  • "result": {
    • "data": [
      • {
        • "email": "user@example.com",
        • "login": "user@example.com",
        • "suspended_incoming": 0,
        • "suspended_login": 0
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}