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.

SecurityBasicAuth

Request

query Parameters

required

string or string or string

The email account's name.

Example: account=user@example.com

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/get_mailbox_status_list

Request samples

whmapi1 --output=jsonpretty \
  get_mailbox_status_list \
  account='user@example.com'

Response samples

application/json

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