---
title: "Return cPanel account mailboxes status list"
method: GET
path: "/get_mailbox_status_list"
tags: ["Mail", "cPanel Account Mail Management"]
---

# Return cPanel account mailboxes status list

`GET /get_mailbox_status_list`

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

**Important:**

  When you disable the [Receive Mail role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.

## Query parameters

- `account` union, required
  - string, email — A valid email account that exists on the server
  - string, username — The cPanel user's account name.
  - string, email — An alias that represents the cPanel user's mailbox

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `mailboxes` object[] — An array that contains information about the mailbox's contents.
      - `guid` string — The alpha-numeric 32-byte mailbox GUID.
      - `mailbox` string — The mailbox name.
      - `messages` integer — The total number of messages in the mailbox.
      - `vsize` integer — The total virtual size of the mailbox's contents, computed with CRLF line terminators.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success * `0` - Failed: Check the reason field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)