Self Help Documentation
< All Topics

email/addemailforwarder

PostedSeptember 16, 2022
UpdatedApril 26, 2023

Description

Creates a new e-mail forwarder in 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.
fromstringYesThe e-mail to add forwarder for.
domainstringYesThe e-mail domain.
tostringYesThe full destination e-mail address. Not required if ‘pipe’ is used.
pipestringNoDefault: none (omitted). If specified, it must contain the path to an existing program to pipe all the e-mail messages to.

Example

PHP
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/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

JSON
PHP
1
2
3
4
5
6
{
    "result": "success",
    "data": {
        "msg": "The forwarder [email protected] > [email protected] has been created successfully"
    }
}
Table of Contents