Self Help Documentation
< All Topics

email/listemailaccounts

PostedSeptember 16, 2022
UpdatedApril 26, 2023

Description

Lists all existing e-mail account users of an existing SPanel user account.

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.

Example

PHP
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
 
$postData = [
  'token' => 'provided_auth_token',
  'accountuser' => 'spanelio',
  'action' => 'email/listemailaccounts',
];
 
$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 );

You can find more information about the Endpoint URL in our API Basics article.

Output

JSON
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
    "result": "success",
    "data": [
        {
            "email": "[email protected]",
            "storage_used": "0",
            "storage_allocated": "102400",
            "storage_utilization": "0",
            "twofactor": false,
            "maildomain": "spanel.io",
            "storage_used_value": 0,
            "storage_used_unit": "MB",
            "storage_allocated_value": 100,
            "row_storage_allocated_value": 100,
            "storage_allocated_unit": "MB",
            "storage_allocated_option": 1
        }
    ]
}
Table of Contents