User Guide

User Guide

VerifyEmail

VerifyEmail

Use the fields in the tables below to configure the input to the operation and to read the output from the operation. The outputs from VerifyEmail include the delivery recommendation for the input email address.
The outputs also include fields that you can read to understand the reasons for the recommendation. To more fully understand the recommendation, consult the StatusNbr value in the ServiceStatus output in conjunction with the
Reason: Code
,
Reason: Description
, and
Hygiene: HygieneResult
values in the ServiceResult output. The recommendation depends on the risk tolerance profile that you specify for the verification request.

Input

The following table describes the input fields:
Field
Description
Sample Input
Email
The email address that you want to verify. Required value.
johndoe@informatica.com
TimeoutSeconds
The amount of time, in seconds, that the service searches for the email address. Enter a value between 1 and 300 seconds. The default value is 29 seconds.
10
SourceId
An ID value to return with the result as a source identifier. Optional value.
Source01
MaxSuggestions
The maximum number of suggestions to be returned as part of the response. The valid value range is 0 through 10. The default value is 3.
5
RiskProfile
The name of the risk tolerance profile that your send recommendations are based on.
Informatica provides out-of-the-box profiles with the following names:
  • Low Risk
  • Medium Risk
  • High Risk
The default profile is Medium Risk.
You can also submit the name of a custom risk tolerance profile. Users can create and customize risk tolerance profiles on the Data as a Service customer portal.
Low Risk

ServiceStatus Output

The following table describes the ServiceStatus output fields:
Field
Description
Sample Output
StatusNbr
Returns a number that represents the status of the request.
See also GetStatusCodes.
200
StatusDescription
Returns the description of the status number.
See also GetStatusCodes.
Email Valid

ServiceResult Output

The following table describes the ServiceResult output fields:
Field
Description
Sample Output
SourceId
Input value in the SourceId parameter.
Source01
Timestamp
The current UTC timestamp.
2019-04-05T07:22:12.9802161Z
Email: Complete
The email address that you entered.
johndoe@informatica.com
Email: LocalPart
The local part of the email address that you entered.
johndoe
Email: DomainPart
The domain name in the email address that you entered.
informatica.com
Email: AliasMasterAddress
When the email address is an alias address, the service returns the master email address in this field.
johndoe@gmail.com
Reason: Code
Further describes the response of the request.
Reason code is associated with a Reason Description and is a subset of a Status Number and Description.
201
Reason: Description
Further describes the response of the request.
Reason Description is a subset of a Status Number and Description.
Mailbox Confirmed
Hygiene: HygieneResult
Result of the Hygiene routine.
Safe US
Hygiene: NetProtected
Indicates if the domain is protected by a third party.
true
Hygiene: NetProtectedBy
The third party protecting the domain.
AppRiver
SendRecommendation: RiskProfile
The name of the risk tolerance profile used to create the current send recommendation.
Low Risk
SendRecommendation: Recommendation
The recommendation on whether to send the email, based on your risk tolerance profile. Use to make a decision on whether or not to send the email.
Possible values:
  • Bad Profile
  • Do not Send
  • Error
  • Retry
  • Send
  • Unknown
You receive the send recommendations based on the combination of the reason logic and the hygiene result.
Send
SendRecommendation: RecommendedRetries
When the send recommendation is Retry, this number indicates how often you should to try to verify the email address before considering it "Do not Send".
2
SendRecommendation: RecommendedRetryDelaySeconds
When the send recommendation is Retry, this number indicates how many seconds you should wait before submitting the email for verification again.
60
DestinationCountry: Code
The ISO 3166-1 numerical country code of the country that hosts the destination mail server, if it is possible to identify it.
840
DestinationCountry: Alpha2Code
The ISO 3166-1 2 digit country code of the country that hosts the destination mail server, if it is possible to identify it.
US
DestinationCountry: Alpha3Code
The ISO 3166-1 3 digit country code of the country that hosts the destination mail server, if it is possible to identify it.
USA
DestinationCountry: Name
The name of the country according to the ISO 3166-1 standard.
United States of America
Cached
Indicates whether the verification result was pulled from the cache. This happens if the email was verified recently.
true
Disposable
Indicates whether the address has a finite life-span.
true
PotentiallyVulgar
Indicates if vulgar words have been identified as part of the email address.
true
VulgarLanguage
When the email address is found to contain potentially vulgar words, this field returns the language as an ISO 639-1 code.
EN
RoleBased
Indicates whether the address identifies a role and not an individual, for example hr@informatica.com.
false
RoleBasedLanguage
When the email address is found to contain potentially role words, this field returns the language as an ISO 639-1 code.
EN
EmailSegment
Indicates the type of email address.
The following list shows the types of email addresses:
  • Personal
  • Business
  • Unknown
Business
PossibleCorrections
A list suggestions for email addresses that may be incorrect or otherwise seem to differ from what the user might have intended. Returns suggestions up to the number that the MaxSuggestions input field specifies.
johndoe@gmail.com
DomainKnowledge
Key/Value pairs of domain information. Reserved for future use.
AddressKnowledge
Key/Value pairs of address information. Reserved for future use.

0 COMMENTS

We’d like to hear from you!