POST api/config/test/smtp

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
RecipientEmail	string	None.
Host	string	None.
Port	integer	None.
SenderDisplayName	string	None.
SenderEmail	string	None.
Username	string	None.
Password	string	None.
EnableSSL	boolean	None.
EnableProxy	boolean	None.
ProxyAddress	string	None.
ProxyPort	integer	None.
ProxyUsername	string	None.
ProxyPassword	string	None.

Request Formats

application/json, text/json

Sample:

{
  "RecipientEmail": "sample string 1",
  "Host": "sample string 2",
  "Port": 3,
  "SenderDisplayName": "sample string 4",
  "SenderEmail": "sample string 5",
  "Username": "sample string 6",
  "Password": "sample string 7",
  "EnableSSL": true,
  "EnableProxy": true,
  "ProxyAddress": "sample string 10",
  "ProxyPort": 11,
  "ProxyUsername": "sample string 12",
  "ProxyPassword": "sample string 13"
}

application/xml, text/xml

Sample:

<DTOSMTPTest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PTI.AF.DTO">
  <EnableProxy>true</EnableProxy>
  <EnableSSL>true</EnableSSL>
  <Host>sample string 2</Host>
  <Password>sample string 7</Password>
  <Port>3</Port>
  <ProxyAddress>sample string 10</ProxyAddress>
  <ProxyPassword>sample string 13</ProxyPassword>
  <ProxyPort>11</ProxyPort>
  <ProxyUsername>sample string 12</ProxyUsername>
  <SenderDisplayName>sample string 4</SenderDisplayName>
  <SenderEmail>sample string 5</SenderEmail>
  <Username>sample string 6</Username>
  <RecipientEmail>sample string 1</RecipientEmail>
</DTOSMTPTest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DTOSMTPTest'.

Response Information

Resource Description

ResultResponse

Name	Type	Additional information
StatusText	string	None.
Error	boolean	None.
Data	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "StatusText": "sample string 1",
  "Error": true,
  "Data": {}
}

application/xml, text/xml

Sample:

<ResultResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PTI.AF.DTO">
  <Data />
  <Error>true</Error>
  <StatusText>sample string 1</StatusText>
</ResultResponse>