Self Help Documentation
email/createemailaccount
Description
Creates a new e-mail account in an existing SPanel user account.
Parameters
Additional parameters:
Field | Type | Required | Description |
---|---|---|---|
token | string | Yes | Authorizing API token – check API Basics for more information. |
accountuser | string | Yes | The SPanel user account that is being managed or viewed. |
action | string | Yes | The category and function being executed. |
string | Yes | The new e-mail account name to be created. | |
domain | string | Yes | The domain of the new e-mail account. |
password | string | Yes | The password for the new e-mail account. |
quota | int | Yes | Quota limit in MB. Minimum limit is 100. |
Example
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
$postData = [
'token' => 'provided_auth_token', // Check API Basics for more information
'accountuser' => 'spanelio',
'action' => 'email/changeemailquota',
'email' => 'mail',
'domain' => 'spanel.io',
'password' => 't3StP@ssw0Rd',
'quota' => 10240, // 10GB disk space limit
];
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endpointUrl);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt( $ch, CURLOPT_POST, true);
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt( $ch, CURLOPT_SSL_VERIFYHOST, false);
$jsonOutput = curl_exec( $ch );
Code language: PHP (php)
Output
{
"result": "success",
"data": {
"msg": "The mailbox [email protected] has been created successfully.",
"description": "You can access your email box from any email client on your computer, phone or tablet.",
"description2": "Important: IMAP, POP3 and SMTP require authentication. Make sure to enable the option \"My SMTP server requires authentication\" in your mail client.",
"createddata": [
[
"Username",
"[email protected]"
],
[
"Password",
"Use the email account's password.",
false
],
[
"Incoming Server",
"mail.spanel.io"
],
[
"IMAP Port",
993
],
[
"POP3 Port",
995
],
[
"Outgoing Server",
"mail.spanel.io"
],
[
"SMTP Port",
465
]
],
"email": "[email protected]"
}
}
Code language: JSON / JSON with Comments (json)