| POST | /ValidateEmail |
|---|
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
Object = TypeVar('Object')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidateEmail:
email: Optional[str] = None
source: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Additional:
has_known_bounces: bool = False
has_spam_reports: bool = False
has_suspected_bounces: bool = False
spam_report_created: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Domain:
has_mx_or_a_record: bool = False
has_valid_address_syntax: bool = False
is_suspected_disposable_address: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LocalPart:
is_suspected_role_address: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Checks:
additional: Optional[Additional] = None
domain: Optional[Domain] = None
local_part: Optional[LocalPart] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Result:
checks: Optional[Checks] = None
email: Optional[str] = None
host: Optional[str] = None
ip__address: Optional[str] = None
local: Optional[str] = None
score: float = 0.0
source: Optional[str] = None
suggestion: Optional[str] = None
verdict: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EmailValidation:
result: Optional[Result] = None
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 /ValidateEmail HTTP/1.1
Host: cpmwebservices-t.clarkpud.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
email: String,
source: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
result:
{
checks:
{
additional:
{
hasKnownBounces: False,
hasSpamReports: False,
hasSuspectedBounces: False,
spamReportCreated: 0001-01-01
},
domain:
{
hasMxOrARecord: False,
hasValidAddressSyntax: False,
isSuspectedDisposableAddress: False
},
localPart:
{
isSuspectedRoleAddress: False
}
},
email: String,
host: String,
ip_Address: String,
local: String,
score: 0,
source: String,
suggestion: String@String,
verdict: String
}
}