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.

SecurityBasicAuth

Request

query Parameters

required

string

The email account for which to enable mailbox autocreation.

Example: email=username@example.com

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Email/enable_mailbox_autocreate

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Email \
  enable_mailbox_autocreate \
  email='username@example.com'

Response samples

application/json

{"apiversion": 3,
"func": "enable_mailbox_autocreate",
"module": "Email",
"result": {"data": 1,
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}