email/setdefaultaddressstatus
Description
Configures what happens to the email messages sent to invalid/non-existent email addresses. Those messages are usually SPAM.
Parameters
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. |
| type | string | Yes | ‘discard’ or ‘forward’. |
| string | No | The email address to forward the messages. Required if ‘type’ set to ‘forward’. |
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/setdefaultaddressstatus',
'domain' => 'spanel.io',
'type' => 'forward',
'email' => '[email protected]'
];
$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
{
"result": "success",
"data": {
"msg": "The default address has been set successfully"
}
}