/mail/add_alias


POST https://api.sitehost.nz/1.2/mail/add_alias.json

Create a new alias on the specified server.

Form Parameters

ParameterTypeRequiredDescription
client_idintegerYesThe ID for the client that the server belongs to.Example: 1
server_namestringYesThe name of the server to create the account on.Example: my-mail-server
sourcestringYesThe source address for the new alias.Example: batman@example.com
destinationstringYesThe email address the alias will point to.Example: bruce@example.com

Code Samples

JavaScript PHP Rails Python
var xmlHttp = new XMLHttpRequest();
xmlHttp.open("POST", "https://api.sitehost.nz/1.2/mail/add_alias.json", false);

var data = new FormData();
data.append("apikey", "your_key_here");
data.append("client_id", "1");
data.append("server_name", "my-mail-server");
data.append("source", "batman@example.com");
data.append("destination", "bruce@example.com");

xmlHttp.send(data);

var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.2/mail/add_alias.json");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
$body = array(
'apikey' => 'your_key_here',
'client_id' => 1,
'server_name' => 'my-mail-server',
'source' => 'batman@example.com',
'destination' => 'bruce@example.com',
);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
require 'net/http'
require 'uri'

uri = URI.parse("https://api.sitehost.nz/1.2/mail/add_alias.json")
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Post.new(uri.request_uri)

body = {"apikey" => "your_key_here",
"client_id" => 1,
"server_name" => "my-mail-server",
"source" => "batman@example.com",
"destination" => "bruce@example.com",
}
request.set_form_data(body)

response = http.request(request)
import requests
from collections import OrderedDict

uri = 'https://api.sitehost.nz/1.2/mail/add_alias.json'

# We need ordered dictionary because parameters have to be in the right order.
# Refer to Developer Notes for more information.
body = OrderedDict()

body['apikey'] = 'your_key_here'
body['client_id'] = 1
body['server_name'] = 'my-mail-server'
body['source'] = 'batman@example.com'
body['destination'] = 'bruce@example.com'

response = requests.post(uri, data=body)

Response

200:

application/json
{
  "return": {
    "job_id": "202927"
  },
  "msg": "Successful.",
  "status": true
}