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
"use strict";
export class EmailAccount {
    /** @param {{id?:string,server?:string,userName?:string,port?:number,emailAddress?:string,displayName?:string,password?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    server;
    /** @type {string} */
    userName;
    /** @type {number} */
    port;
    /** @type {string} */
    emailAddress;
    /** @type {string} */
    displayName;
    /** @type {string} */
    password;
}
export class SendTestEmail {
    /** @param {{account?:EmailAccount,emailAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {EmailAccount}
     * @description The email account to send from */
    account;
    /**
     * @type {string}
     * @description The user to send to */
    emailAddress;
}

JavaScript 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: team.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>