Requires any of the roles: | SystemAdministrator, Manager, Customer |
POST | /settings/test-email |
---|
namespace Voice.Api.Settings
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type EmailAccount() =
member val Id:String = null with get,set
member val Server:String = null with get,set
member val UserName:String = null with get,set
member val Port:Int32 = new Int32() with get,set
member val EmailAddress:String = null with get,set
member val DisplayName:String = null with get,set
member val Password:String = null with get,set
///<summary>
///Send a test email from the specified account
///</summary>
[<Api(Description="Send a test email from the specified account")>]
[<AllowNullLiteral>]
type SendTestEmail() =
interface IPost
///<summary>
///The email account to send from
///</summary>
[<ApiMember(Description="The email account to send from")>]
member val Account:EmailAccount = null with get,set
///<summary>
///The user to send to
///</summary>
[<ApiMember(Description="The user to send to")>]
member val EmailAddress:String = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
account:
{
id: String,
server: String,
userName: String,
port: 0,
emailAddress: String,
displayName: String,
password: String
},
emailAddress: String
}