SiteHost API: /mail/search

/mail /search_aliases

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

Search the list of aliases on the specified server. At least one of the query options is required.

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 to search.Example: my-mail-server
query[source]	string		Filter by source.Example: batman@example.com
query[destination]	string		Filter by destination.Example: bruce@example.com
offsets[offset]	integer		Offset the results by the defined amount.Example: 0
offsets[limit]	integer		Limit your search to the defined number of results.Example: 10

Code Samples

JavaScript PHP Rails Python

var xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.3/mail/search_aliases.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&query[source]=batman%40example.com&query[destination]=bruce%40example.com&offsets[offset]=0&offsets[limit]=10", false);

xmlHttp.send();

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.3/mail/search_aliases.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&query[source]=batman%40example.com&query[destination]=bruce%40example.com&offsets[offset]=0&offsets[limit]=10");
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/search_aliases.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&query[source]=batman%40example.com&query[destination]=bruce%40example.com&offsets[offset]=0&offsets[limit]=10")
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/search_aliases.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&query[source]=batman%40example.com&query[destination]=bruce%40example.com&offsets[offset]=0&offsets[limit]=10'

response = requests.get(uri)

Response

200:

application/json

{
  "return": [
    {
      "client_id": "1",
      "source": "batman@example.com",
      "destination": "bruce@example.com"
    }
  ],
  "msg": "Successful.",
  "status": true
}