SiteHost API

/mail/list_all

Returns a list of all email addresses on the specified server and domain. Includes mailboxes, nicknames and forwarders.

Query Parameters

Code Samples

var xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.1/mail/list_all.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&domain=example.com", false);

xmlHttp.send();

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.1/mail/list_all.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&domain=example.com");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$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.1/mail/list_all.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&domain=example.com")
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Get.new(uri.request_uri)

response = http.request(request)

import requests

uri = 'https://api.sitehost.nz/1.1/mail/list_all.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&domain=example.com'

response = requests.get(uri)

Response