email/setmailroute

PostedSeptember 16, 2022

UpdatedApril 25, 2023

Description

Updates the mail exchanger rule to use local or remote server for e-mail sending/receiving.

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.
domain	string	Yes	The domain to apply the new settings.
exchanger	string	Yes	‘localexchanger’ or ‘remoteexchanger’ depending on your preference.
mailserver	array	No	Array of mail servers. Required if ‘exchanger’ set to ‘remoteexchanger’.
priority	array	No	Array of priorities corresponding to the mail servers. Required if ‘exchanger’ set to ‘remoteexchanger’.

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/setmailroute',

'domain' => 'spanel.io',

'exchanger' => 'localexchanger',

//'exchanger' => 'remoteexchanger',

//'mailserver' => ['mail.domain.com', 'mail2.domain.com'],

//'priority' => [0,1]

];

$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 );

{

"result": "success",

"msg": "Your mail exchanger settings for domain spanel.io have been updated"

}