Description
This function creates an email address.
Examples
Note:
Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.
Parameters
Parameter |
Type |
Description |
Possible values |
Example |
|
string |
Required The email account username or address. |
|
user |
password |
string |
Required The email account password. |
A secure password. |
12345luggage |
domain |
string |
The email account's domain. This parameter defaults to the cPanel account's main domain. |
A valid domain on the cPanel account. For example, example.com to createuser@example.com. |
example.com |
quota |
integer |
The maximum amount of disk space that the new email account may use. This parameter defaults to 250. |
A positive integer that represents the maximum amount of disk space, in Megabytes (MB). Note: To grant unlimited disk space, specify 0. |
500 |
skip_update_db |
Boolean |
Whether to skip the update of the email accounts database's cache. This parameter defaults to 0. |
|
1 |
password_hash |
string |
The account's password hash. Note:
|
A valid password hash that utilizes your server's cryptographic hash function. Note: You can find your server's hash type in the/etc/sysconfig/authconfigfile. |
|
Returns
Return |
Type |
Description |
Possible values |
Example |
data |
string |
The email address. |
The email account username, a plus character (+), and the email account domain. |
user+example.com |