UAPI accesses the cPanel interface's features. Use this API to access and modify cPanel account data and settings.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/
A server running cPanel.
https://{host}:{port}/execute/
Request
This function deletes an email address.
Important:
When you disable the Receive Mail role, the system disables this function.
Security
BasicAuth
Query
The email account username or address.
- A valid email account username. For example,
userif the email address isuser@example.com. - A valid email address.
Example: email=user@domain.com
Any of:
string(email)
The email account's domain. For example, example.com if the email address is user@example.com.
Default "The cPanel account's main domain."
Example: domain=example.com
Whether to remove the mail account's home mail directory. If you do not specify a value, the function removes the mail account's home directory.
passwd— Preserve the mail account's home directory.- Any other value — Remove the mail account's home directory.
Example: flags=passwd
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/delete_pop
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/delete_pop
- 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/cpanel.openapi/Email/delete_pop?email=user%40domain.com&domain=example.com&flags=passwd&skip_quota=0'Response
application/json
{ "apiversion": 3, "func": "delete_pop", "module": "Email", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function sends an email account's client settings to an email address.
Important:
When you disable the Receive Mail role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/dispatch_client_settings
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/dispatch_client_settings
- 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/cpanel.openapi/Email/dispatch_client_settings?account=username&to=user%40example.com'Response
application/json
{ "apiversion": 3, "func": "dispatch_client_settings", "module": "Email", "result": { "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Query
The email account's domain. Defaults to the cPanel account's main domain.
Example: domain=example.com
The maximum amount of disk space that the new email account may use. Defaults to the system value.
- A positive integer that represents the maximum amount of disk space, in megabytes (MB).
Note:
You cannot enter a value that exceeds the maximum email quota.
0orunlimited— The account possesses unlimited disk space.
If the email account's quota value is set higher (or unlimited) than the account's max quota, the account's max quota will be applied instead of the value entered.
Note:
This value is only available to users without a maximum email account quota.
Example: quota=500
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/edit_pop_quota
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/edit_pop_quota
- 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/cpanel.openapi/Email/edit_pop_quota?domain=example.com&email=user"a=500'Response
application/json
{ "apiversion": 3, "func": "edit_pop_quota", "module": "Email", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }