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.

SecurityBasicAuth

Request

query Parameters

required

string <email>

The email account address to query.

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/get_mailbox_autocreate

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

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

Response samples

application/json

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