SiteHost API: /mail/list

/mail /list_all

GET https://api.sitehost.nz/1.3/mail/list_all.json

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

Query Parameters

Parameter	Type	Required	Description
client_id	integer	Yes	The ID for the client that the server belongs to.Example: 1
server_name	string	Yes	The name of the server that the domain is on.Example: my-mail-server
domain	string	Yes	The name of the domain to list addresses for.Example: example.com

Code Samples

JavaScript PHP Rails Python

var xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.3/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.3/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.3/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.3/mail/list_all.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&domain=example.com'

response = requests.get(uri)

Response

200:

application/json

{
  "return": [
    {
      "type": 0,
      "username": "bruce@example.com",
      "emailaddr": "bruce@example.com",
      "label": "Bruce"
    },
    {
      "type": 0,
      "username": "alfred@example.com",
      "emailaddr": "alfred@example.com",
      "label": "Alfred"
    },
    {
      "type": 1,
      "emailaddr": "thomas@example.com",
      "destination": "bruce@example.com"
    }
    {
      "type": 2,
      "emailaddr": "batman@example.com",
      "destination": "bruce@example.com"
    }
  ],
  "msg": "Successful.",
  "status": true
}