Global Email:Request: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
(7 intermediate revisions by the same user not shown) | |||
Line 8: | Line 8: | ||
A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your Customer ID (License Key) and at least one input email address. | A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your Customer ID (License Key) and at least one input email address. | ||
Global Email | Global Email supports JSON, JSONP, REST, and XML protocols. | ||
Line 98: | Line 98: | ||
:<h4 style="border-bottom:1px solid black;">VerifyMailBox</h4> | :<h4 style="border-bottom:1px solid black;">VerifyMailBox</h4> | ||
:: | ::Validates email mailbox. | ||
::{| class="alternate01 sortable" | ::{| class="alternate01 sortable" | ||
!Option Name !! Parameter !! Description | !Option Name !! Parameter !! Description | ||
|- | |- | ||
|rowspan="2"|'''VerifyMailBox'''||<code>Express</code>||'''''Default.''''' | |rowspan="2"|'''VerifyMailBox'''||<code>Express</code>||'''''Default.''''' Quickly validates against database of known email addresses. | ||
|- | |- | ||
|<code>Premium</code>|| | |<code>Premium</code>||A real time check is performed to determine email deliverability. | ||
|} | |} | ||
Line 128: | Line 128: | ||
|- | |- | ||
|'''TimeToWait'''||<code># [5 - 45]</code>||'''''Default set to 25.''''' Select how long the web service will wait before it times out on an email. | |'''TimeToWait'''||<code># [5 - 45]</code>||'''''Default set to 25.''''' Select how long the web service will wait before it times out on an email. | ||
|} | |||
:<h4 style="border-bottom:1px solid black;">WhoIsLookup</h4> | |||
::WhoIsLookup returns the domain information. | |||
::{| class="alternate01 sortable" | |||
!Option Name !! Parameter !! Description | |||
|- | |||
|rowspan="2"|'''WhoIsLookup'''||<code>On</code>||'''''Default''''' Activates domain information Lookups. | |||
|- | |||
|<code>Off</code>||Deactivates domain information Lookups. | |||
|} | |||
:<h4 style="border-bottom:1px solid black;">AllowQuotes</h4> | |||
::AllowQuotes provides the option of allowing special characters in mailbox names. | |||
::{| class="alternate01 sortable" | |||
!Option Name !! Parameter !! Description | |||
|- | |||
|rowspan="2"|'''AllowQuotes'''||<code>On</code>||'''''Default''''' Allow double-quoted mailbox names. This allows special characters and whitespace within a valid quoted string. | |||
|- | |||
|<code>Off</code>||Do not allow double-quoted mailbox names. Illegal special characters and whitespace will be stripped. | |||
|} | |} | ||
Line 134: | Line 158: | ||
:''Optional.'' | :''Optional.'' | ||
:The desired format of the response. | :The desired format of the response. Possible values for this option are "json" or "xml". The default value is "xml". | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 178: | Line 202: | ||
:''Required.'' | :''Required.'' | ||
:The email to be verified. | :The email or domain to be verified. Domains should start with <code>@</code>. | ||
:{| class="alternate01" | :{| class="alternate01" |
Latest revision as of 19:44, 28 April 2023
Global Email Navigation | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
| ||||||||
| ||||||||
| ||||||||
Sample Code |
A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your Customer ID (License Key) and at least one input email address.
Global Email supports JSON, JSONP, REST, and XML protocols.
URL
REST, XML, JSON, etc.
Use URL Standard http://globalemail.melissadata.net/v4/WEB/GlobalEmail/doGlobalEmail Secure https://globalemail.melissadata.net/v4/WEB/GlobalEmail/doGlobalEmail
Field Names
This is a list of the request field names and their protocol naming conventions.
Field Name | Level | REST | JSON |
---|---|---|---|
Transmission Reference | Request | t | TransmissionReference |
License Key | id | CustomerID | |
Options | opt | Options | |
Format | format | Format | |
Record ID | Record | RecordID | |
Request Elements
The following elements set the basic options for each request. These apply to the entire request, not the individual records.
Transmission Reference
- Optional.
- This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Protocol Syntax JSON "TransmissionReference":"string"
REST ?t = string
XML <TransmissionReference>string</TransmissionReference>
License Key
- Required.
- This is a string value containing the License Key issued to the customer by Melissa Data for Global Email.
- If this element is absent, the Web Service will return an error. To receive a License Key, please contact your Melissa sales representative at 1-800-MELISSA.
Protocol Syntax JSON "CustomerID":"string"
REST &id = string
XML <CustomerID>string</CustomerID>
Options
- Optional.
- This is a string value containing the options you set.
Protocol Syntax JSON "Options":"string"
REST ?opt = string
XML <Options>string</Options>
- List options in the following format, with multiple options delimited with a ",".
Syntax OptionName:Parameter,OptionName:Parameter
VerifyMailBox
- Validates email mailbox.
Option Name Parameter Description VerifyMailBox Express
Default. Quickly validates against database of known email addresses. Premium
A real time check is performed to determine email deliverability.
DomainCorrection
- DomainCorrection turns on fuzzy correction on suspected email domains typos.
Option Name Parameter Description DomainCorrection On
Default. Activates fuzzy email domain correction if the domain is a suspected typo. Off
No email domain correction.
TimeToWait
- TimeToWait allows you to select how long (in seconds) that you would like our web service to wait on a single email before it times out. Select a smaller number if time is of essence, or longer if you would prefer more accurate results.
Option Name Parameter Description TimeToWait # [5 - 45]
Default set to 25. Select how long the web service will wait before it times out on an email.
WhoIsLookup
- WhoIsLookup returns the domain information.
Option Name Parameter Description WhoIsLookup On
Default Activates domain information Lookups. Off
Deactivates domain information Lookups.
AllowQuotes
- AllowQuotes provides the option of allowing special characters in mailbox names.
Option Name Parameter Description AllowQuotes On
Default Allow double-quoted mailbox names. This allows special characters and whitespace within a valid quoted string. Off
Do not allow double-quoted mailbox names. Illegal special characters and whitespace will be stripped.
Format
- Optional.
- The desired format of the response. Possible values for this option are "json" or "xml". The default value is "xml".
Protocol Syntax REST &format = string
JSON (HTTP Header) Accept: application/json
XML (HTTP Header) Accept: application/xml
Request Record Elements
JSON will only contain the Records element.
Protocol | Definition |
---|---|
JSON | Each email will be contained within [{}] under the Records element. |
REST | The REST interface only allows a single record per request. |
XML | There will be one RequestRecord element per address being submitted to the Cloud Service. |
RecordID
- Optional.
- This is a string value containing a unique identifier for the current record. Use this to match the record submitted with the record returned. It will return what is inputted.
Protocol Syntax JSON "RecordID":"string"
XML <RecordID>string</RecordID>
- Required.
- The email or domain to be verified. Domains should start with
@
.
Protocol Syntax JSON "Email":"string"
REST &email = string
XML <Email>string</Email>