Evo Voice

<back to all web services

SendTestEmail

Send a test email from the specified account

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, Customer
The following routes are available for this service:
POST/settings/test-email
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Send a test email from the specified account
*/
@Api(Description="Send a test email from the specified account")
open class SendTestEmail : IPost
{
    /**
    * The email account to send from
    */
    @ApiMember(Description="The email account to send from")
    var account:EmailAccount? = null

    /**
    * The user to send to
    */
    @ApiMember(Description="The user to send to")
    var emailAddress:String? = null
}

open class EmailAccount
{
    var id:String? = null
    var server:String? = null
    var userName:String? = null
    var port:Int? = null
    var emailAddress:String? = null
    var displayName:String? = null
    var password:String? = null
}

Kotlin SendTestEmail DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /settings/test-email HTTP/1.1 
Host: evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendTestEmail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Settings">
  <Account>
    <DisplayName>String</DisplayName>
    <EmailAddress>String</EmailAddress>
    <Id>String</Id>
    <Password>String</Password>
    <Port>0</Port>
    <Server>String</Server>
    <UserName>String</UserName>
  </Account>
  <EmailAddress>String</EmailAddress>
</SendTestEmail>