GET /system/email_servers

Retrieves a list of all email servers.

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

Table 2. GET /system/email_servers request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
filter	query	Optional	String	text/plain	Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.
Range	header	Optional	String	text/plain	Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
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 response codes
HTTP Response Code	Unique Code	Description
200		The requested list of email server records was successfully retrieved.
500	1000	Problem encountered while attempting to read the database.
500	1001	Problem encountered while attempting to read the default email server from the database.

Response Description

A list of the email servers. An email server record that contains the following fields:

id - Number - ID of the email server.
description - String - Description identifying 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"
    }
]