CPU.Notifications

<back to all web services

ValidateEmail

The following routes are available for this service:
POST/ValidateEmail
namespace CPU.Notifications.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ValidateEmail() = 
        member val Email:String = null with get,set
        member val Source:String = null with get,set

    [<AllowNullLiteral>]
    type Additional() = 
        member val HasKnownBounces:Boolean = new Boolean() with get,set
        member val HasSpamReports:Boolean = new Boolean() with get,set
        member val HasSuspectedBounces:Boolean = new Boolean() with get,set
        member val SpamReportCreated:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type Domain() = 
        member val HasMxOrARecord:Boolean = new Boolean() with get,set
        member val HasValidAddressSyntax:Boolean = new Boolean() with get,set
        member val IsSuspectedDisposableAddress:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type LocalPart() = 
        member val IsSuspectedRoleAddress:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type Checks() = 
        member val Additional:Additional = null with get,set
        member val Domain:Domain = null with get,set
        member val LocalPart:LocalPart = null with get,set

    [<AllowNullLiteral>]
    type Result() = 
        member val Checks:Checks = null with get,set
        member val Email:String = null with get,set
        member val Host:String = null with get,set
        member val Ip_Address:String = null with get,set
        member val Local:String = null with get,set
        member val Score:Single = new Single() with get,set
        member val Source:String = null with get,set
        member val Suggestion:String = null with get,set
        member val Verdict:String = null with get,set

    [<AllowNullLiteral>]
    type EmailValidation() = 
        member val Result:Result = null with get,set

F# ValidateEmail DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
	}
}