<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 | | |
---|
SendTestEmail Parameters:Name | Parameter | Data Type | Required | Description |
---|
Account | body | EmailAccount | No | The email account to send from |
EmailAddress | body | string | No | The user to send to |
EmailAccount Parameters:Name | Parameter | Data Type | Required | Description |
---|
Id | form | string | No | |
Server | form | string | No | |
UserName | form | string | No | |
Port | form | int | No | |
EmailAddress | form | string | No | |
DisplayName | form | string | No | |
Password | form | string | No | |
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>