CPcpanel
Mailboxes
Mailbox Management

Return cPanel account's mailbox status

This function lists the account's mailbox size and globally unique identifier (GUID) by folder.

get/Mailboxes/get_mailbox_status_list

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Query parameters

accountstring required
Example:user@example.com

The email account for which you you wish to request the status.

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": "get_mailbox_status_list",
  "module": "Mailboxes",
  "result": {
    "data": [
      {
        "guid": "1234560f0c58d158c92a000044f0d230",
        "mailbox": "INBOX.marla_singer@example_com",
        "messages": 0,
        "vsize": 0
      },
      {
        "guid": "11234560f0c58d158c92a000044f0d23",
        "mailbox": "INBOX.angel_face@example_com",
        "messages": 0,
        "vsize": 0
      },
      {
        "guid": "111234560f0c58d158c92a000044f0d2",
        "mailbox": "INBOX.tyler_durden@example_com",
        "messages": 0,
        "vsize": 0
      },
      {
        "guid": "1111234560f0c58d158c92a000044f0d",
        "mailbox": "INBOX.Trash",
        "messages": 0,
        "vsize": 0
      },
      {
        "guid": "11111234560f0c58d158c92a000044f0",
        "mailbox": "INBOX.narrator@example_com",
        "messages": 0,
        "vsize": 0
      },
      {
        "guid": "111111234560f0c58d158c92a000044f",
        "mailbox": "INBOX",
        "messages": 0,
        "vsize": 0
      },
      {
        "guid": "1111111234560f0c58d158c92a000004",
        "mailbox": "INBOX.Sent",
        "messages": 0,
        "vsize": 0
      },
      {
        "guid": "11111111234560f0c58d158c92a00000",
        "mailbox": "INBOX.Drafts",
        "messages": 0,
        "vsize": 0
      },
      {
        "guid": "111111111234560f0c58d158c92a0000",
        "mailbox": "INBOX.robert_paulsen@example_com",
        "messages": 0,
        "vsize": 0
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.