Sign in
latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Mail
cPanel Account Mail Management

Return cPanel account mailboxes status list

This function lists the status of a cPanel's mail account's mailboxes.

Important:

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

get/get_mailbox_status_list

Query parameters

string email required

A valid email account that exists on the server

OR
string username required

The cPanel user's account name.

OR
string email required

An alias that represents the cPanel user's mailbox

Example:user@example.com

The email account's name.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "mailboxes": [
      {
        "guid": "1234560f0c58d158c92a000044f0d230",
        "mailbox": "INBOX.marla_singer@example_com"
      }
    ]
  },
  "metadata": {
    "command": "get_mailbox_status_list",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}