/mail/get_account
GET https://api.sitehost.nz/1.0/mail/get_account.json
Returns details for the specified account.
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 account is on.Example: my-mail-server |
string | Yes | The email address of the account to return.Example: bruce@example.com |
Code Samples
JavaScript PHP Rails Pythonvar xmlHttp = new XMLHttpRequest();
xmlHttp.open("GET", "https://api.sitehost.nz/1.0/mail/get_account.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&email=bruce%40example.com", false);
xmlHttp.send();
var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.0/mail/get_account.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&email=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.0/mail/get_account.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&email=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.0/mail/get_account.json?apikey=your_key_here&client_id=1&server_name=my-mail-server&email=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",
"policy_message_count": "0",
"policy_message_max": "0",
"last_updated": "0000-00-00 00:00:00",
"key": ""
},
"msg": "Successful.",
"status": true,
"time": 44.09
}
"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",
"policy_message_count": "0",
"policy_message_max": "0",
"last_updated": "0000-00-00 00:00:00",
"key": ""
},
"msg": "Successful.",
"status": true,
"time": 44.09
}