v1

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

Return cPanel account's mailbox autocreate status

This function checks whether a cPanel account will automatically create mailboxes when it receives an email address in plus address format.

Note:

To enable or disable this functionality, use the UAPI's Email::enable_mailbox_autocreate and Email::disable_mailbox_autocreate functions.

get/Email/get_mailbox_autocreate

Query parameters

emailstring email required
Example:username@example.com

The email account address to query.

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": "get_mailbox_autocreate",
  "module": "Email",
  "result": {
    "data": 1,
    "status": 1
  }
}