model

Documentation

Index

• type Address
  • func MapInternationalAddress(lookup *international_street.Lookup) *Address
  • func MapUSAddress(lookup *extract.Lookup) *Address
• type EmailDeliverableStatus
• type IpLookupRequest
• type IpLookupResponse
• type ValidateEmailMailSherpaData
• type ValidateEmailRequest
• type ValidateEmailRequestOptions
• type ValidateEmailRequestWithOptions
• type ValidateEmailResponse
• type ValidateEmailWithScrubbyResponse
• type ValidateEmailWithTrueinboxResponse
• type ValidationAddressRequest
• type ValidationAddressResponse
  • func MapValidationInternationalAddressResponse(lookup *international_street.Lookup, error *string, valid bool) ValidationAddressResponse
  • func MapValidationNoAddressResponse(error *string) ValidationAddressResponse
  • func MapValidationUsAddressResponse(lookup *extract.Lookup, error *string, valid bool) ValidationAddressResponse
• type ValidationPhoneNumberRequest
• type ValidationPhoneNumberResponse
  • func MapValidationPhoneNumberResponse(e164 *string, countryA2 *string, error *string, valid bool) ValidationPhoneNumberResponse

Types

type Address

type Address struct {
	Country      string  `json:"country"`
	Region       string  `json:"region"`
	District     string  `json:"district"`
	Locality     string  `json:"locality"`
	Street       string  `json:"street"`
	Zip          string  `json:"zip"`
	PostalCode   string  `json:"postalCode"`
	AddressLine1 string  `json:"addressLine1"`
	AddressLine2 string  `json:"addressLine2"`
	AddressType  string  `json:"addressType"`
	HouseNumber  string  `json:"houseNumber"`
	PlusFour     string  `json:"plusFour"`
	Commercial   bool    `json:"commercial"`
	Predirection string  `json:"predirection"`
	Latitude     float64 `json:"latitude"`
	Longitude    float64 `json:"longitude"`
	TimeZone     string  `json:"timeZone"`
	UtcOffset    int     `json:"utcOffset"`
}

func MapInternationalAddress

func MapInternationalAddress(lookup *international_street.Lookup) *Address

func MapUSAddress

func MapUSAddress(lookup *extract.Lookup) *Address

type EmailDeliverableStatus

type EmailDeliverableStatus string

const (
	EmailDeliverableStatusDeliverable   EmailDeliverableStatus = "true"
	EmailDeliverableStatusUndeliverable EmailDeliverableStatus = "false"
	EmailDeliverableStatusUnknown       EmailDeliverableStatus = "unknown"
)

type IpLookupRequest

type IpLookupRequest struct {
	Ip string `json:"ip"`
}

type IpLookupResponse

type IpLookupResponse struct {
	Status  string                             `json:"status"`
	Message string                             `json:"message,omitempty"`
	IpData  *postgresentity.IPDataResponseBody `json:"ipdata,omitempty"`
}

type ValidateEmailMailSherpaData

type ValidateEmailMailSherpaData struct {
	Email  string `json:"email"`
	Syntax struct {
		IsValid    bool   `json:"isValid"`
		User       string `json:"user"`
		Domain     string `json:"domain"`
		CleanEmail string `json:"cleanEmail"`
	} `json:"syntax"`
	DomainData struct {
		IsFirewalled          bool   `json:"isFirewalled"`
		Provider              string `json:"provider"`
		SecureGatewayProvider string `json:"secureGatewayProvider"`
		IsCatchAll            bool   `json:"isCatchAll"`
		CanConnectSMTP        bool   `json:"canConnectSMTP"`
		HasMXRecord           bool   `json:"hasMXRecord"`
		HasSPFRecord          bool   `json:"hasSPFRecord"`
		TLSRequired           bool   `json:"tlsRequired"`
		ResponseCode          string `json:"responseCode"`
		ErrorCode             string `json:"errorCode"`
		Description           string `json:"description"`
		IsPrimaryDomain       bool   `json:"isPrimaryDomain"`
		PrimaryDomain         string `json:"primaryDomain"`
	} `json:"domainData"`
	EmailData struct {
		SkippedValidation bool   `json:"skippedValidation"` // if true, email validation was skipped
		Deliverable       string `json:"deliverable"`
		IsMailboxFull     bool   `json:"isMailboxFull"`
		IsRoleAccount     bool   `json:"isRoleAccount"`
		IsSystemGenerated bool   `json:"isSystemGenerated"`
		IsFreeAccount     bool   `json:"isFreeAccount"`
		SmtpSuccess       bool   `json:"smtpSuccess"`
		ResponseCode      string `json:"responseCode"`
		ErrorCode         string `json:"errorCode"`
		Description       string `json:"description"`
		RetryValidation   bool   `json:"retryValidation"` // if true, email validation should be retried
		TLSRequired       bool   `json:"tlsRequired"`
		AlternateEmail    string `json:"alternateEmail"`
	} `json:"emailData"`
}

type ValidateEmailRequest

type ValidateEmailRequest struct {
	Email string `json:"email"`
}

type ValidateEmailRequestOptions

type ValidateEmailRequestOptions struct {
	VerifyCatchAll      bool `json:"verifyCatchAll"`
	ExtendedWaitingTime bool `json:"extendedWaitingTime"`
}

type ValidateEmailRequestWithOptions

type ValidateEmailRequestWithOptions struct {
	Email   string                      `json:"email"`
	Options ValidateEmailRequestOptions `json:"options"`
}

type ValidateEmailResponse

type ValidateEmailResponse struct {
	Status          string                       `json:"status"`
	Message         string                       `json:"message,omitempty"`
	InternalMessage string                       `json:"internalMessage,omitempty"`
	Data            *ValidateEmailMailSherpaData `json:"data,omitempty"`
}

type ValidateEmailWithScrubbyResponse

type ValidateEmailWithScrubbyResponse struct {
	Status          string `json:"status"`
	Message         string `json:"message,omitempty"`
	InternalMessage string `json:"internalMessage,omitempty"`
	EmailIsValid    bool   `json:"emailIsValid"`
	EmailIsInvalid  bool   `json:"emailIsInvalid"`
	EmailIsUnknown  bool   `json:"emailIsUnknown"`
	EmailIsPending  bool   `json:"emailIsPending"`
}

type ValidateEmailWithTrueinboxResponse

type ValidateEmailWithTrueinboxResponse struct {
	Status  string                                `json:"status"`
	Message string                                `json:"message,omitempty"`
	Data    *postgresentity.TrueInboxResponseBody `json:"data,omitempty"`
}

type ValidationAddressRequest

type ValidationAddressRequest struct {
	Address       string `json:"address"`
	Country       string `json:"country"`
	International bool   `json:"international"`
}

type ValidationAddressResponse

type ValidationAddressResponse struct {
	Address *Address `json:"address"`
	Valid   bool     `json:"valid"`
	Error   *string  `json:"error"`
}

func MapValidationInternationalAddressResponse

func MapValidationInternationalAddressResponse(lookup *international_street.Lookup, error *string, valid bool) ValidationAddressResponse

func MapValidationNoAddressResponse

func MapValidationNoAddressResponse(error *string) ValidationAddressResponse

func MapValidationUsAddressResponse

func MapValidationUsAddressResponse(lookup *extract.Lookup, error *string, valid bool) ValidationAddressResponse

type ValidationPhoneNumberRequest

type ValidationPhoneNumberRequest struct {
	PhoneNumber string `json:"phoneNumber"`
	Country     string `json:"country"`
}

type ValidationPhoneNumberResponse

type ValidationPhoneNumberResponse struct {
	E164      *string `json:"e164"`
	CountryA2 *string `json:"countryA2"`
	Valid     bool    `json:"valid"`
	Error     *string `json:"error"`
}

func MapValidationPhoneNumberResponse

func MapValidationPhoneNumberResponse(e164 *string, countryA2 *string, error *string, valid bool) ValidationPhoneNumberResponse