WHM API.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
A server running WHM.
https://{host}:{port}/json-api/
Request
This function removes mail messages from a cPanel account that you select with a query.
Important:
When you disable the Receive Mail role, the system disables this function.
Security
BasicAuth
Query
An email account that exists on the server.
Example: account=user@example.com
A mailbox name on the account.
Note:
Because you cannot escape wildcard characters such as (*), we recommend that you use functions that use the mailbox_guid parameter instead. For example, the WHM API 1 expunge_messages_for_mailbox_guid function.
Example: mailbox=INBOX
A Dovecot search query to select which messages you wish to remove from the mailbox.
Example: query=savedbefore 52w
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/expunge_mailbox_messages
- A server running WHM.
https://whm-server.tld:2087/json-api/expunge_mailbox_messages
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/expunge_mailbox_messages?account=user%40example.com&mailbox=INBOX&query=savedbefore+52w'Response
application/json
{ "metadata": { "command": "expunge_mailbox_messages", "reason": "OK", "result": 1, "version": 1 } }
Request
This function removes mail messages from a cPanel account.
Important:
When you disable the Receive Mail role, the system disables this function.
Security
BasicAuth
Query
The mailbox's globally unique identifier (GUID).
Note:
To find the mailbox GUID, use the WHM API 1 - get_mailbox_status function.
Example: mailbox_guid=2550860f0c58d158c92a000044f0d230
The Dovecot search query to select which messages you wish to remove from the mailbox. For more information, read Dovecot's Search Query documentation.
Example: query=savedbefore 52w
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/expunge_messages_for_mailbox_guid
- A server running WHM.
https://whm-server.tld:2087/json-api/expunge_messages_for_mailbox_guid
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/expunge_messages_for_mailbox_guid?account=user%40example.com&mailbox_guid=2550860f0c58d158c92a000044f0d230&query=savedbefore+52w'Response
application/json
{ "metadata": { "command": "expunge_messages_for_mailbox_guid", "reason": "OK", "result": 1, "version": 1 } }
Request
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.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_mailbox_status
- A server running WHM.
https://whm-server.tld:2087/json-api/get_mailbox_status
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_mailbox_status?account=user%40example.com'HTTP Request was successful.
Example: {"INBOX":{"guid":"111111234560f0c58d158c92a000044f","messages":42000,"vsize":42},"INBOX.Drafts":{"guid":"11111111234560f0c58d158c92a00000","messages":5,"vsize":522},"INBOX.Sent":{"guid":"1111111234560f0c58d158c92a000004","messages":1,"vsize":56},"INBOX.Trash":{"guid":"1111234560f0c58d158c92a000044f0d","messages":2001,"vsize":5643},"INBOX.angel_face@example_com":{"guid":"11234560f0c58d158c92a000044f0d23","messages":3,"vsize":1524},"INBOX.marla_singer@example_com":{"guid":"1234560f0c58d158c92a000044f0d230","messages":5,"vsize":100},"INBOX.narrator@example_com":{"guid":"11111234560f0c58d158c92a000044f0","messages":0,"vsize":0},"INBOX.robert_paulsen@example_com":{"guid":"111111111234560f0c58d158c92a0001","messages":2,"vsize":2222},"INBOX.tyler_durden@example_com":{"guid":"111234560f0c58d158c92a000044f0d2","messages":55,"vsize":12244}}
Response
application/json
{ "data": { "INBOX": { … }, "INBOX.Drafts": { … }, "INBOX.Sent": { … }, "INBOX.Trash": { … }, "INBOX.angel_face@example_com": { … }, "INBOX.marla_singer@example_com": { … }, "INBOX.narrator@example_com": { … }, "INBOX.robert_paulsen@example_com": { … }, "INBOX.tyler_durden@example_com": { … } }, "metadata": { "command": "get_mailbox_status", "reason": "OK", "result": 1, "version": 1 } }