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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Voice.Api.Settings

Namespace Global

    Namespace Voice.Api.Settings

        Public Partial Class EmailAccount
            Public Overridable Property Id As String
            Public Overridable Property Server As String
            Public Overridable Property UserName As String
            Public Overridable Property Port As Integer
            Public Overridable Property EmailAddress As String
            Public Overridable Property DisplayName As String
            Public Overridable Property Password As String
        End Class

        '''<Summary>
        '''Send a test email from the specified account
        '''</Summary>
        <Api(Description:="Send a test email from the specified account")>
        Public Partial Class SendTestEmail
            Implements IPost
            '''<Summary>
            '''The email account to send from
            '''</Summary>
            <ApiMember(Description:="The email account to send from")>
            Public Overridable Property Account As EmailAccount

            '''<Summary>
            '''The user to send to
            '''</Summary>
            <ApiMember(Description:="The user to send to")>
            Public Overridable Property EmailAddress As String
        End Class
    End Namespace
End Namespace

VB.NET SendTestEmail DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"account":{"id":"String","server":"String","userName":"String","port":0,"emailAddress":"String","displayName":"String","password":"String"},"emailAddress":"String"}