| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| POST | /settings/test-email |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EmailAccount:
id: Optional[str] = None
server: Optional[str] = None
user_name: Optional[str] = None
port: Optional[int] = None
email_address: Optional[str] = None
display_name: Optional[str] = None
password: Optional[str] = None
# @Api(Description="Send a test email from the specified account")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SendTestEmail(IPost):
"""
Send a test email from the specified account
"""
# @ApiMember(Description="The email account to send from")
account: Optional[EmailAccount] = None
"""
The email account to send from
"""
# @ApiMember(Description="The user to send to")
email_address: Optional[str] = None
"""
The user to send to
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>