REST API for Oracle Commerce Cloud December 2017

testSmtpConnection

post

/ccadmin/v1/email/test

Test Smtp Connection. Test the SMTP connection for the supplied email service data.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : testSmtpConnection_request

Example


{
    "emailSMTPPort":"25",
    "emailSMTPHost":"127.0.0.1",
    "emailSMTPAuthMethod":"TLS",
    "emailSMTPPassword":"",
    "emailSMTPUsername":""
}

Properties

emailSMTPAuthMethod: Type: string

The SMTP Authorisation method - either SSL or TLS.
emailSMTPHost: Type: string

The SMTP host.
emailSMTPPassword: Type: string

User password for the SMTP server.
emailSMTPPort: Type: string

Port to use to communicate with the SMTP host.
emailSMTPUsername: Type: string

User login for the SMTP server.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : testSmtpConnection_response

Properties

status: Type: boolean

Will be set to true if the connection test succeeded, false otherwise.

Example application/json


{
    "status":true
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{
  "emailSMTPPort": "25",
  "emailSMTPHost": "127.0.0.1",
  "emailSMTPAuthMethod": "TLS",
  "emailSMTPPassword": "",
  "emailSMTPUsername": ""
}

Sample Response Payload returned by endpoint:

{"status": true}