/mail/list_accounts


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

Returns a list of accounts on the specified server and domain.

Query Parameters

ParameterTypeRequiredDescription
client_idintegerYesThe ID for the client that the server belongs to.Example: 1
server_namestringYesThe name of the server that the domain is on.Example: my-mail-server
domainstringYesThe name of the domain to list accounts for.Example: example.com
filters[emailaddr]stringFilter your search by the email address.Example: bruce@example.com

Code Samples

JavaScript PHP Rails Python
var xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.3/mail/list_accounts.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&domain=example.com&filters[emailaddr]=bruce%40example.com", false);

xmlHttp.send();

var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.3/mail/list_accounts.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&domain=example.com&filters[emailaddr]=bruce%40example.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_accounts.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&domain=example.com&filters[emailaddr]=bruce%40example.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_accounts.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&domain=example.com&filters[emailaddr]=bruce%40example.com'

response = requests.get(uri)

Response

200:

application/json
{
  "return": [
    {
      "client_id": "1",
      "username": "bruce@example.com",
      "label": "Bruce",
      "emailaddr": "bruce@example.com",
      "autoresponder": "0",
      "autoresponder_text": "",
      "spam_strategy": "0",
      "active": "yes",
      "quota": "0",
      "quota_used": "0",
      "quota_percent": "0",
      "message_count": "0",
      "last_updated": "0000-00-00 00:00:00"
    },
    {
      "client_id": "1",
      "username": "alfred@example.com",
      "label": "Alfred",
      "emailaddr": "alfred@example.com",
      "autoresponder": "0",
      "autoresponder_text": "",
      "spam_strategy": "0",
      "active": "yes",
      "quota": "150",
      "quota_used": "0",
      "quota_percent": "0",
      "message_count": "0",
      "last_updated": "0000-00-00 00:00:00"
    }
  ],
  "msg": "Successful.",
  "status": true
}