Self Help Documentation
< All Topics

email/getemailflow

Posted
Updated

Description

Returns the current email flow settings – sending, receiving and the hourly sending limit – of an existing email account or domain for 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.
modestringNoDefault: ’email’. ’email’ / ‘domain’ – whether the settings of an email account or of a whole domain are being read.
emailstringNoThe existing email account to be read. Required when mode is ’email’.
domainstringNoThe existing domain or subdomain to be read. Required when mode is ‘domain’.

Info
In the output, outgoing and incoming are the settings of the email account itself, while domain_outgoing and domain_outgoinglimit are the settings of its domain. A value of 1 means enabled, 0 means disabled. An email account cannot send emails while sending is disabled for its domain, and it cannot exceed the hourly limit of its domain.

Example

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

PHP
1
2
3
4
5
6
7
8
9
10
11
12
{
    "result": "success",
    "data": {
        "msg": "",
        "status": 1,
        "domain_outgoing": 1,
        "outgoing": 1,
        "incoming": 1,
        "domain_outgoinglimit": "unlimited",
        "outgoinglimit": "500"
    }
}
Table of Contents