GET /system/email_servers/{email_server_id}

Retrieves an email server based on the supplied email server ID.

Table 1. GET /system/email_servers/{email_server_id} resource details
MIME Type
application/json

Table 2. GET /system/email_servers/{email_server_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
email_server_id	path	Required	Number (Integer)	text/plain	Required - The ID of the server.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. GET /system/email_servers/{email_server_id} response codes
HTTP Response Code	Unique Code	Description
200		The requested email server record was retrieved.
404	2000	The email server does not exist.
500	2001	Problem encountered while attempting to read the default email server from the database.

Response Description

An email server record that contains the following fields:

id - Number - ID of the email server.
description - String - Description of the email server.
hostname - String - Hostname of the email server.
port - Number - Port to connect to the email server with.
username - String - User name to authenticate with the email server.
password - String - Password to authenticate with the email server.
enable_tls - Boolean - Whether to ignore TLS verification errors to the email server.

Response Sample


{
    "default": true,
    "description": "String",
    "enable_tls": true,
    "hostname": "String",
    "id": 42,
    "password": "String",
    "port": 42,
    "username": "String"
}