/mail/search_accounts
GET https://api.sitehost.nz/1.2/mail/search_accounts.json
Search the list of accounts 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[emailaddr] | string | Filter by email address.Example: bruce@example.com | |
query[username] | string | Filter by user name.Example: bruce@example.com | |
query[active] | string | Filter by active status.Example: 1 | |
query[quota] | integer | Filter by quota.Example: 100 | |
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 Pythonvar xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.2/mail/search_accounts.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&query[emailaddr]=bruce%40example.com&query[username]=bruce%40example.com&query[active]=1&query[quota]=100&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.2/mail/search_accounts.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&query[emailaddr]=bruce%40example.com&query[username]=bruce%40example.com&query[active]=1&query[quota]=100&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.2/mail/search_accounts.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&query[emailaddr]=bruce%40example.com&query[username]=bruce%40example.com&query[active]=1&query[quota]=100&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.2/mail/search_accounts.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&query[emailaddr]=bruce%40example.com&query[username]=bruce%40example.com&query[active]=1&query[quota]=100&offsets[offset]=0&offsets[limit]=10'
response = requests.get(uri)
Response
200:application/json
{
"return": [
{
"client_id": "1",
"emailaddr": "bruce@example.com",
"label": "Bruce",
"username": "bruce@example.com",
"autoresponder": "0",
"autoresponder_text": "",
"active": "yes",
"quota": "0",
"spam_strategy": "0"
}
],
"msg": "Successful.",
"status": true
}
"return": [
{
"client_id": "1",
"emailaddr": "bruce@example.com",
"label": "Bruce",
"username": "bruce@example.com",
"autoresponder": "0",
"autoresponder_text": "",
"active": "yes",
"quota": "0",
"spam_strategy": "0"
}
],
"msg": "Successful.",
"status": true
}