email/addemailforwarder
Description
Creates a new e-mail forwarder in an existing SPanel user account.
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. |
| from | string | Yes | The e-mail to add forwarder for. |
| domain | string | Yes | The e-mail domain. |
| to | string | Yes | The full destination e-mail address. Not required if ‘pipe’ is used. |
| pipe | string | No | Default: none (omitted). If specified, it must contain the path to an existing program to pipe all the e-mail messages to. |
Example
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
$postData = [
'token' => 'provided_auth_token',
'accountuser' => 'spanelio',
'action' => 'email/addemailforwarder',
'from' => 'mail',
'domain' => 'spanel.io',
'to' => '[email protected]',
//'pipe' => 'home/spanelio/pipe.php'
];
$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
{
"result": "success",
"data": {
"msg": "The forwarder [email protected] > [email protected] has been created successfully"
}
}