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 disables the system's ability to automatically create mailboxes for a cPanel account.
Note:
When you enable the UAPI's Email::enable_mailbox_autocreate function, the system automatically creates mailboxes. The system creates a new mailbox when it receives an email address in plus address format and that mailbox does not exist. For example, receiving an email from the user+newmailbox@example.com address creates the newmailbox mailbox if the newmailbox mailbox does not exist.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/disable_mailbox_autocreate
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/disable_mailbox_autocreate
- 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/disable_mailbox_autocreate?email=username%40example.com'Response
application/json
{ "apiversion": 3, "func": "disable_mailbox_autocreate", "module": "Email", "result": { "data": 1, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function allows the system to automatically create mailboxes for a cPanel account. The system will create a new mailbox when it receives an email address in plus address format and that mailbox does not exist. For example, receiving an email from the user+newmailbox@example.com address creates the newmailbox mailbox if the newmailbox mailbox does not exist.
Note:
To disable this functionality, use the UAPI Email::disable_mailbox_autocreate function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/enable_mailbox_autocreate
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/enable_mailbox_autocreate
- 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/enable_mailbox_autocreate?email=username%40example.com'Response
application/json
{ "apiversion": 3, "func": "enable_mailbox_autocreate", "module": "Email", "result": { "data": 1, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function lists the available character encodings.
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/fetch_charmaps
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/fetch_charmaps
- 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/fetch_charmapsResponse
application/json
{ "apiversion": 3, "func": "fetch_charmaps", "module": "Email", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }