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
namespace Voice.Api.Settings

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type EmailAccount() = 
        member val Id:String = null with get,set
        member val Server:String = null with get,set
        member val UserName:String = null with get,set
        member val Port:Int32 = new Int32() with get,set
        member val EmailAddress:String = null with get,set
        member val DisplayName:String = null with get,set
        member val Password:String = null with get,set

    ///<summary>
    ///Send a test email from the specified account
    ///</summary>
    [<Api(Description="Send a test email from the specified account")>]
    [<AllowNullLiteral>]
    type SendTestEmail() = 
        interface IPost
        ///<summary>
        ///The email account to send from
        ///</summary>
        [<ApiMember(Description="The email account to send from")>]
        member val Account:EmailAccount = null with get,set

        ///<summary>
        ///The user to send to
        ///</summary>
        [<ApiMember(Description="The user to send to")>]
        member val EmailAddress:String = null with get,set

F# 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>