Global Email:Response: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 25: | Line 25: | ||
|Total Records||TotalRecords | |Total Records||TotalRecords | ||
|- | |- | ||
|Record ID||rowspan=" | |Record ID||rowspan="29" valign="center"|Record||RecordID | ||
|- | |- | ||
|Results||Results | |Results||Results | ||
| Line 34: | Line 34: | ||
|- | |- | ||
|Domain Name||DomainName | |Domain Name||DomainName | ||
|- | |||
|Domain Authentication Status||DomainAuthenticationStatus | |||
|- | |- | ||
|Top Level Domain||TopLevelDomain | |Top Level Domain||TopLevelDomain | ||
| Line 40: | Line 42: | ||
|- | |- | ||
|Date Checked||DateChecked | |Date Checked||DateChecked | ||
|- | |||
|Email Age Estimated||EmailAgeEstimated | |||
|- | |- | ||
|Deliverability Confidence Score||DeliverabilityConfidenceScore | |Deliverability Confidence Score||DeliverabilityConfidenceScore | ||
| Line 74: | Line 78: | ||
|- | |- | ||
|MX Server||MXServer | |MX Server||MXServer | ||
|- | |||
|Domain Type Indicator||DomainTypeIndicator | |||
|- | |||
|Breach Count||BreachCount | |||
|} | |} | ||
| Line 171: | Line 179: | ||
<h3 class="h3grey">Email Address</h3> | <h3 class="h3grey">Email Address</h3> | ||
:A string value listing the email address, including any corrections or changes made by Global Email V4. | :A string value listing the email address or domain, including any corrections or changes made by Global Email V4. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
| Line 207: | Line 215: | ||
|- | |- | ||
|XML||<code><DomainName>'''''string'''''</DomainName></code> | |XML||<code><DomainName>'''''string'''''</DomainName></code> | ||
|} | |||
<h3 class="h3grey">Domain Authentication Status</h3> | |||
:A string value listing the security protocols used on the receiving mail server. | |||
:{| class="alternate01" | |||
!Protocol !! Syntax | |||
|- | |||
|JSON||<code>"DomainAuthenticationStatus":"'''''string'''''"</code> | |||
|- | |||
|XML||<code><DomainAuthenticationStatus>'''''string'''''</DomainAuthenticationStatus></code> | |||
|} | |} | ||
| Line 245: | Line 265: | ||
|- | |- | ||
|XML||<code><DateChecked>'''''string'''''</DateChecked></code> | |XML||<code><DateChecked>'''''string'''''</DateChecked></code> | ||
|} | |||
<h3 class="h3grey">Email Age Estimated</h3> | |||
:The estimated minimum age of the email in days based on historical data. The value is zero when we lack historical data on a given email. | |||
:{| class="alternate01" | |||
!Protocol !! Syntax | |||
|- | |||
|JSON||<code>"EmailAgeEstimated":"'''''string'''''"</code> | |||
|- | |||
|XML||<code><EmailAgeEstimated>'''''string'''''</EmailAgeEstimated></code> | |||
|} | |} | ||
| Line 449: | Line 481: | ||
|- | |- | ||
|XML||<code><MXServer>'''''string'''''</MXServer></code> | |XML||<code><MXServer>'''''string'''''</MXServer></code> | ||
|} | |||
<h3 class="h3grey">Domain Type Indicator</h3> | |||
:A string value predicts if email belongs to a personal or business/organization email by analyzing the domain. | |||
:{| class="alternate01" | |||
!Protocol !! Syntax | |||
|- | |||
|JSON||<code>"DomainTypeIndicator":"'''''string'''''"</code> | |||
|- | |||
|XML||<code><DomainTypeIndicator>'''''string'''''</DomainTypeIndicator></code> | |||
|} | |||
<h3 class="h3grey">Breach Count</h3> | |||
:A string value listing the known number of breaches that this email account has been involved in. | |||
:{| class="alternate01" | |||
!Protocol !! Syntax | |||
|- | |||
|JSON||<code>"BreachCount":"'''''string'''''"</code> | |||
|- | |||
|XML||<code><BreachCount>'''''string'''''</BreachCount></code> | |||
|} | |} | ||
Latest revision as of 00:08, 9 September 2022
| Global Email Navigation | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
| ||||||||
| ||||||||
| ||||||||
| Sample Code |
A response is the result of a request. This consists of returned results codes and parsed email elements.
Depending on the protocol used to make the request, the response will be in a certain protocol. Global Email supports the JSON, JSONP, and XML protocols.
Field Names
This is a list of the response field names and their protocol naming conventions.
| Field Name | Level | JSON/XML |
|---|---|---|
| Version | Response (Base) | Version |
| Transmission Reference | TransmissionReference | |
| Transmission Results | TransmissionResults | |
| Total Records | TotalRecords | |
| Record ID | Record | RecordID |
| Results | Results | |
| Email Address | EmailAddress | |
| Mailbox Name | MailboxName | |
| Domain Name | DomainName | |
| Domain Authentication Status | DomainAuthenticationStatus | |
| Top Level Domain | TopLevelDomain | |
| Top Level Domain Name | TopLevelDomainName | |
| Date Checked | DateChecked | |
| Email Age Estimated | EmailAgeEstimated | |
| Deliverability Confidence Score | DeliverabilityConfidenceScore | |
| Domain Age Estimated | DomainAgeEstimated | |
| Domain Expiration Date | DomainExpirationDate | |
| Domain Created Date | DomainCreatedDate | |
| Domain Updated Date | DomainUpdatedDate | |
| Domain Email | DomainEmail | |
| Domain Organization | DomainOrganization | |
| Domain Address 1 | DomainAddress1 | |
| Domain Locality | DomainLocality | |
| Domain Administrative Area | DomainAdministrativeArea | |
| Domain Postal Code | DomainPostalCode | |
| Domain Country | DomainCountry | |
| Domain Country Code | DomainCountryCode | |
| Domain Availability | DomainAvailability | |
| Domain Private Proxy | DomainPrivateProxy | |
| Privacy Flag | PrivacyFlag | |
| MX Server | MXServer | |
| Domain Type Indicator | DomainTypeIndicator | |
| Breach Count | BreachCount |
Response Elements
The following elements are the basic options for each request. These apply to the entire response, not the individual records.
Version
- This is a string value that is the current revision number of Global Email V4.
Protocol Syntax JSON "Version":"string"XML <Version>string</Version>
Transmission Reference
- This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.
Protocol Syntax JSON "TransmissionReference":"string"XML <TransmissionReference>string</TransmissionReference>
Transmission Results
- This is a string value that lists error codes from any errors caused by the most recent request as a whole.
- For a complete list of error codes, see Global Email Result V4 Codes.
Protocol Syntax JSON "TransmissionResults":"string"XML <TransmissionResults>string</TransmissionResults>
Total Records
- Displays the total number of records returned.
Protocol Syntax JSON "TotalRecords":"string"XML <TotalRecords>string</TotalRecords>
Response Record Elements
JSON will only contain the Records element.
Protocol Definition JSON Each record will be contained within [{}] under the Records element. XML
Each of the following elements are returned for each record in the Response Array.
Record ID
- A string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.
Protocol Syntax JSON "RecordID":"string"XML <RecordID>string</RecordID>
Results
- A string value with comma delimited status, error codes, and change codes for the record.
- For a complete list of codes, see Global Email V4 Result Codes.
Protocol Syntax JSON "Results":"string"XML <Results>string</Results>
Email Address
- A string value listing the email address or domain, including any corrections or changes made by Global Email V4.
Protocol Syntax JSON "EmailAddress":"string"XML <EmailAddress>string</EmailAddress>
Mailbox Name
- A string value listing the mailbox or user name portion of the email address (All characters preceding the "@" character).
- With an example email of "sample@melissa.com" the mailbox name would be "sample".
Protocol Syntax JSON "MailboxName":"string"XML <MailboxName>string</MailboxName>
Domain Name
- A string value listing the domain name portion of the email address (All characters between the "@" and "." characters).
- With an example email of "sample@melissa.com" the domain name would be "melissa".
Protocol Syntax JSON "DomainName":"string"XML <DomainName>string</DomainName>
Domain Authentication Status
- A string value listing the security protocols used on the receiving mail server.
Protocol Syntax JSON "DomainAuthenticationStatus":"string"XML <DomainAuthenticationStatus>string</DomainAuthenticationStatus>
Top Level Domain
- A string value listing the description associated with the top-level domain name of the email address.
Protocol Syntax JSON "Top Level Domain":"string"XML <Top Level Domain>string</Top Level Domain>
Top Level Domain Name
- A string value listing the top level domain name portion of the email address (All characters after the ".").
- With an example email of "sample@melissa.com" the top level domain name would be "com".
Protocol Syntax JSON "TopLevelDomainName":"string"XML <TopLevelDomainName>string</TopLevelDomainName>
Date Checked
- A string value listing the date the email was last checked. It returns UTC, Unix Time (Epoch Time) in the
MM/DD/YYYY H:MM:SSformat.
Protocol Syntax JSON "DateChecked":"string"XML <DateChecked>string</DateChecked>
Email Age Estimated
- The estimated minimum age of the email in days based on historical data. The value is zero when we lack historical data on a given email.
Protocol Syntax JSON "EmailAgeEstimated":"string"XML <EmailAgeEstimated>string</EmailAgeEstimated>
DeliverabilityConfidenceScore
- Returns the probability [0-100]% of an email sent to this mailbox will be successfully delivered.
Protocol Syntax JSON "DeliverabilityConfidenceScore":"string"XML <DeliverabilityConfidenceScore>string</DeliverabilityConfidenceScore>
DomainAgeEstimated
- The estimated age of the domain in days.
Protocol Syntax JSON "DomainAgeEstimated":"string"XML <DomainAgeEstimated>string</DomainAgeEstimated>
DomainExpirationDate
- The date the domain expires/expired in the
YYYY-MM-DDTHH:MM:SSformat.
Protocol Syntax JSON "DomainExpirationDate":"string"XML <DomainExpirationDate>string</DomainExpirationDate>
DomainCreatedDate
- The date the domain was created in the
YYYY-MM-DDTHH:MM:SSformat.
Protocol Syntax JSON "DomainCreatedDate":"string"XML <DomainCreatedDate>string</DomainCreatedDate>
DomainUpdatedDate
- The date the domain was last updated in the
YYYY-MM-DDTHH:MM:SSformat.
Protocol Syntax JSON "DomainUpdatedDate":"string"XML <DomainUpdatedDate>string</DomainUpdatedDate>
DomainEmail
- The email associated with the domain.
Protocol Syntax JSON "DomainEmail":"string"XML <DomainEmail>string</DomainEmail>
DomainOrganization
- The organization associated with the domain.
Protocol Syntax JSON "DomainOrganization":"string"XML <DomainOrganization>string</DomainOrganization>
DomainAddress1
- The street address associated with the domain.
Protocol Syntax JSON "DomainAddress1":"string"XML <DomainAddress1>string</DomainAddress1>
DomainLocality
- The locality associated with the domain.
Protocol Syntax JSON "DomainLocality":"string"XML <DomainLocality>string</DomainLocality>
DomainAdministrativeArea
- The administrative area associated with the domain.
Protocol Syntax JSON "DomainAdministrativeArea":"string"XML <DomainAdministrativeArea>string</DomainAdministrativeArea>
DomainPostalCode
- The postal code associated with the domain.
Protocol Syntax JSON "DomainPostalCode":"string"XML <DomainPostalCode>string</DomainPostalCode>
DomainCountry
- The country associated with the domain.
Protocol Syntax JSON "DomainCountry":"string"XML <DomainCountry>string</DomainCountry>
DomainCountryCode
- The country code associated with the domain.
Protocol Syntax JSON "DomainCountryCode":"string"XML <DomainCountryCode>string</DomainCountryCode>
DomainAvailability
- Check to see if domain is available for purchase.
Protocol Syntax JSON "DomainAvailability":"string"XML <DomainAvailability>string</DomainAvailability>
DomainPrivateProxy
- Check if domain is behind a private proxy.
Protocol Syntax JSON "DomainPrivateProxy":"string"XML <DomainPrivateProxy>string</DomainPrivateProxy>
Privacy Flag
- The top level domain may be sensitive to privacy laws. Returns
Yfor yes andNfor no.
Protocol Syntax JSON "PrivacyFlag":"string"XML <PrivacyFlag>string</PrivacyFlag>
MX Server
- Returns which Mail Exchange (MX) Server was used to validate the email.
Protocol Syntax JSON "MXServer":"string"XML <MXServer>string</MXServer>
Domain Type Indicator
- A string value predicts if email belongs to a personal or business/organization email by analyzing the domain.
Protocol Syntax JSON "DomainTypeIndicator":"string"XML <DomainTypeIndicator>string</DomainTypeIndicator>
Breach Count
- A string value listing the known number of breaches that this email account has been involved in.
Protocol Syntax JSON "BreachCount":"string"XML <BreachCount>string</BreachCount>