CPU.Notifications

ValidateEmail

The following routes are available for this service:
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

Python ValidateEmail DTOs

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 /ValidateEmail HTTP/1.1 
Host: cpmwebservices-t.clarkpud.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ValidateEmail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CPU.Notifications.ServiceModel">
  <Email>String</Email>
  <Source>String</Source>
</ValidateEmail>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EmailValidation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CPU.SendGridAPI">
  <Result>
    <Checks>
      <Additional>
        <HasKnownBounces>false</HasKnownBounces>
        <HasSpamReports>false</HasSpamReports>
        <HasSuspectedBounces>false</HasSuspectedBounces>
        <SpamReportCreated>0001-01-01T00:00:00</SpamReportCreated>
      </Additional>
      <Domain>
        <HasMxOrARecord>false</HasMxOrARecord>
        <HasValidAddressSyntax>false</HasValidAddressSyntax>
        <IsSuspectedDisposableAddress>false</IsSuspectedDisposableAddress>
      </Domain>
      <LocalPart>
        <IsSuspectedRoleAddress>false</IsSuspectedRoleAddress>
      </LocalPart>
    </Checks>
    <Email>String</Email>
    <Host>String</Host>
    <Ip_Address>String</Ip_Address>
    <Local>String</Local>
    <Source>String</Source>
    <Verdict>String</Verdict>
  </Result>
</EmailValidation>