Preparing to send a test mail

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-20

The following operation is the initial step to send a test email.

Execution permission

Admin

Request line

GET baseURL/v1/services/EmailServerSettings/actions/sendTestMail

Request body

Not applicable.

Response body

The structure of the response body and the object attributes is as follows:

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

Attribute	Type	Description
name	string	Name of the action.
href	string	URL for the action.
method	string	Name of the method.
type	string	Data format for the object.
parameters	anyType[]	A list of TestMail objects necessary to execute an operation. For details, see the table below.

TestMail

{
        "destinationAddresses":["...", ...],
        "emailSetting":{
            "instanceID":"...",
            "hostname":"...",
            "authenticationEnabled":"...",
            "userId":"...",
            "senderAddress":"...",
            "secureConnection":"...",
            "portNumber":"..."
        }
}

TestMail (Type: TestMail)

Attribute	Type	Description
destinationAddresses	string[]	Email address specified as the destination of the test email
emailSetting	EmailSetting	Email server settings used to send a test email

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.) TLS Plain STARTTLS
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/services/EmailServerSettings/actions/sendTestMail
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:44 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]
{
  "name" : "sendTestMail",
  "href" : "http://localhost:22015/Analytics/v1/services/EmailServerSettings/actions/sendTestMail/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "emailSetting" : {
      "instanceID" : "mailServerSetting#0",
      "hostname" : "172.17.17.116",
      "authenticationEnabled" : false,
      "userId" : "user1",
      "senderAddress" : "user@example.com",
      "secureConnection" : "Plain",
      "portNumber" : 25
    }
  } ]
}