Return cPanel account's mailbox status

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

SecurityBasicAuth

Request

query Parameters

account

required

string

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

Example: account=user@example.com

Responses

200

HTTP Request was successful.

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

get/Mailboxes/get_mailbox_status_list

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Mailboxes \
  get_mailbox_status_list \
  account='user@example.com'

Response samples

application/json

{"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
}
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}