Self Help Documentation
< All Topics

email/createemailaccount

PostedSeptember 16, 2022
UpdatedApril 26, 2023

Description

Creates a new e-mail account in an existing SPanel user account.

Parameters

Additional parameters:

FieldTypeRequiredDescription
tokenstringYesAuthorizing API token – check API Basics for more information.
accountuserstringYesThe SPanel user account that is being managed or viewed.
actionstringYesThe category and function being executed.
emailstringYesThe new e-mail account name to be created.
domainstringYesThe domain of the new e-mail account.
passwordstringYesThe password for the new e-mail account.
quotaintYesQuota limit in MB. Minimum limit is 100.

Example

PHP
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
$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 );

Output

JSON
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
    "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]"
    }
}
Table of Contents