Self Help Documentation
< All Topics

email/setemailflow

Posted
Updated

Description

Changes the 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 changed.
emailstringNoThe existing email account to be changed. Required when mode is ’email’.
domainstringNoThe existing domain or subdomain to be changed. Required when mode is ‘domain’.
sendemailsboolNoDefault: false (unset). Set to 1 to allow sending emails, 0 to block it.
receiveemailsboolNoDefault: false (unset). Set to 1 to allow receiving emails, 0 to block it. Ignored when mode is ‘domain’.
maxemailsperhourintNoThe maximum number of email messages that may be sent within 1 hour. 0 for unlimited. The current limit is kept if the parameter is not provided.

Warning
Both sendemails and receiveemails are applied on every call, so omitting one of them blocks that direction. Always send both parameters with their desired values – use email/getemailflow first if you only want to change one of them.

Info
An email account cannot send emails while sending is disabled for its domain. In that case sendemails and maxemailsperhour are ignored and only receiveemails is applied.

Example

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',
  'accountuser' => 'spanelio',
  'action' => 'email/setemailflow',
  'email' => '[email protected]',
  'sendemails' => 0,
  'receiveemails' => 1,
  'maxemailsperhour' => 200
];
 
$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
{
    "result": "success",
    "data": {
        "msg": [
            "Sending emails has been <strong>disabled</strong> successfully",
            "Receiving emails has been <strong>enabled</strong> successfully"
        ]
    }
}
Table of Contents