| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| POST | /settings/test-email |
|---|
export class NodeParameterMap
{
[key:string] : NodeParameter;
public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}
export class EmailAccount
{
public id?: string;
public server?: string;
public userName?: string;
public port?: number;
public emailAddress?: string;
public displayName?: string;
public password?: string;
public constructor(init?: Partial<EmailAccount>) { (Object as any).assign(this, init); }
}
/**
* Send a test email from the specified account
*/
// @Api(Description="Send a test email from the specified account")
export class SendTestEmail implements IPost
{
/**
* The email account to send from
*/
// @ApiMember(Description="The email account to send from")
public account?: EmailAccount;
/**
* The user to send to
*/
// @ApiMember(Description="The user to send to")
public emailAddress?: string;
public constructor(init?: Partial<SendTestEmail>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}