POST 17.0/app/email/settings/test

Description

Tests the passed email settings to determine whether they work

URI Parameters

None.

Details of the email settings to test

EmailSettingsTest
Name Description Type Additional information
FromEmail

string

None.
ToEmail

string

None.
Settings

EmailSettings

None.

application/json, text/json
Sample: 
{
  "fromEmail": "sample string 1",
  "toEmail": "sample string 2",
  "settings": {
    "id": 1,
    "emailAddress": "sample string 2",
    "smtpServerName": "sample string 3",
    "smtpUserName": "sample string 4",
    "smtpUserPassword": "sample string 5",
    "smtpAuthenticationType": 64,
    "smtpPort": 7,
    "smtpssl": 64,
    "imapServerName": "sample string 9",
    "imapUserName": "sample string 10",
    "imapUserPassword": "sample string 11",
    "imapPort": 12,
    "imapssl": 64,
    "sendingPause": 14,
    "defaultAccount": 64,
    "processInbox": 64,
    "authenticationMethod": 64,
    "oAuthToken": "sample string 18",
    "authenticationStatus": 64,
    "inActive": 64
  }
}

application/xml, text/xml
Sample: 
<EmailSettingsTest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <FromEmail>sample string 1</FromEmail>
  <ToEmail>sample string 2</ToEmail>
  <Settings>
    <ID>1</ID>
    <EmailAddress>sample string 2</EmailAddress>
    <SMTPServerName>sample string 3</SMTPServerName>
    <SMTPUserName>sample string 4</SMTPUserName>
    <SMTPUserPassword>sample string 5</SMTPUserPassword>
    <SMTPAuthenticationType>64</SMTPAuthenticationType>
    <SMTPPort>7</SMTPPort>
    <SMTPSSL>64</SMTPSSL>
    <IMAPServerName>sample string 9</IMAPServerName>
    <IMAPUserName>sample string 10</IMAPUserName>
    <IMAPUserPassword>sample string 11</IMAPUserPassword>
    <IMAPPort>12</IMAPPort>
    <IMAPSSL>64</IMAPSSL>
    <SendingPause>14</SendingPause>
    <DefaultAccount>64</DefaultAccount>
    <ProcessInbox>64</ProcessInbox>
    <AuthenticationMethod>64</AuthenticationMethod>
    <OAuthToken>sample string 18</OAuthToken>
    <AuthenticationStatus>64</AuthenticationStatus>
    <InActive>64</InActive>
  </Settings>
</EmailSettingsTest>

application/x-www-form-urlencoded
Sample:

Sample not available.

BooleanSuccessMessage
Name Description Type Additional information
Success

boolean

None.
Message

string

None.

application/json, text/json
Sample: 
{
  "success": true,
  "message": "sample string 2"
}

application/xml, text/xml
Sample: 
<BooleanSuccessMessage xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <Message>sample string 2</Message>
</BooleanSuccessMessage>