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.*;

public class dtos
{

    /**
    * Send a test email from the specified account
    */
    @Api(Description="Send a test email from the specified account")
    public static class SendTestEmail implements IPost
    {
        /**
        * The email account to send from
        */
        @ApiMember(Description="The email account to send from")
        public EmailAccount account = null;

        /**
        * The user to send to
        */
        @ApiMember(Description="The user to send to")
        public String emailAddress = null;
        
        public EmailAccount getAccount() { return account; }
        public SendTestEmail setAccount(EmailAccount value) { this.account = value; return this; }
        public String getEmailAddress() { return emailAddress; }
        public SendTestEmail setEmailAddress(String value) { this.emailAddress = value; return this; }
    }

    public static class EmailAccount
    {
        public String id = null;
        public String server = null;
        public String userName = null;
        public Integer port = null;
        public String emailAddress = null;
        public String displayName = null;
        public String password = null;
        
        public String getId() { return id; }
        public EmailAccount setId(String value) { this.id = value; return this; }
        public String getServer() { return server; }
        public EmailAccount setServer(String value) { this.server = value; return this; }
        public String getUserName() { return userName; }
        public EmailAccount setUserName(String value) { this.userName = value; return this; }
        public Integer getPort() { return port; }
        public EmailAccount setPort(Integer value) { this.port = value; return this; }
        public String getEmailAddress() { return emailAddress; }
        public EmailAccount setEmailAddress(String value) { this.emailAddress = value; return this; }
        public String getDisplayName() { return displayName; }
        public EmailAccount setDisplayName(String value) { this.displayName = value; return this; }
        public String getPassword() { return password; }
        public EmailAccount setPassword(String value) { this.password = value; return this; }
    }

}

Java 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>