v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Email
Email Server Information

Enable cPanel account mailbox autocreation

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.

get/Email/enable_mailbox_autocreate

Query parameters

emailstring required
Example:username@example.com

The email account for which to enable mailbox autocreation.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "enable_mailbox_autocreate",
  "module": "Email",
  "result": {
    "data": 1,
    "status": 1
  }
}