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 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
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
get_mailbox_status \
account='user@example.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 } }
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_list
- A server running WHM.
https://whm-server.tld:2087/json-api/get_mailbox_status_list
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
get_mailbox_status_list \
account='user@example.com'Response
application/json
{ "data": { "mailboxes": [ … ] }, "metadata": { "command": "get_mailbox_status_list", "reason": "OK", "result": 1, "version": 1 } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_unique_recipient_count_per_sender_for_user
- A server running WHM.
https://whm-server.tld:2087/json-api/get_unique_recipient_count_per_sender_for_user
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
get_unique_recipient_count_per_sender_for_user \
user='username' \
start_time='1550872800' \
end_time='1550923200'Response
application/json
{ "data": { "payload": [ … ] }, "metadata": { "command": "get_unique_recipient_count_per_sender_for_user", "reason": "OK", "result": 1, "version": 1 } }