You can display a list of SMTP server settings, such as the host name and port number.
Execution permission
Admin
Request line
GET baseURL/v1/objects/EmailServerSettings
Request body
Not applicable.
Response body
The structure of the response body and the object attributes is as follows:Collections
{ "data":["...", ...], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
Attribute |
Type |
Description |
---|---|---|
data |
anyType[] |
A list of EmailSetting objects. For details, see the table below. |
pagination |
Pagination |
Page information. This parameter is displayed only when the relevant resource exists. |
count |
int |
Number of data items that meet the conditions related to this query(API). |
pagination (Type: Pagination)
Attribute |
Type |
Description |
---|---|---|
page |
integer |
Page. |
pageSize |
integer |
Size of page. |
numPages |
integer |
Number of pages. |
totalCount |
integer |
Number of objects. |
EmailSetting
{ "instanceID":"...", "hostname":"...", "authenticationEnabled":"...", "userId":"...", "senderAddress":"...", "secureConnection":"...", "portNumber":"..." }
EmailSetting (Type: EmailSetting)
Attribute |
Type |
Description |
---|---|---|
instanceID |
string |
ID of the mail server settings |
hostname |
string |
IP address or host name of the SMTP server |
authenticationEnabled |
boolean |
Whether or not to enable authentication of the user who sends emails. If enabled, "true" is set. If disabled, "false" is set. |
userId |
string |
User ID used for authentication of the user who sends emails. This item is set only if authenticationEnabled is "true". |
senderAddress |
string |
Sender address |
secureConnection |
enum |
Setting of security used when emails are sent (For details about the valid values, see the table SecureConnectionType in List of enumerators.)
|
portNumber |
int |
Port number used for connection to the SMTP server |
Status codes
Status code |
Reason phrase |
Description |
---|---|---|
200 |
OK |
Success. |
401 |
Unauthorized |
No login privilege. |
412 |
Precondition Failed |
The server is not available. |
500 |
Internal Server Error |
Server processing error. |
Example code
[Request Header] GET /Analytics/v1/objects/EmailServerSettings Authorization: Basic c3lzdGVtOm1hbmFnZXI= Host: localhost:22015 Accept: application/json Content-Type: application/json [Response Header] HTTP/1.1 200 OK Date: Wed, 20 Jul 2016 02:50:43 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO 33659a74fcee4358dc272b34eca6ded1bf1131ec_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810 X-Frame-Options: SAMEORIGIN X-XSS-Protection: 1; mode=block X-Content-Type-Options: nosniff Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "data" : [ { "instanceID" : "mailServerSetting#0", "hostname" : "smtp server", "authenticationEnabled" : false, "secureConnection" : "Plain", "portNumber" : 25 } ], "count" : 1 }