Global Email:Request - Revision history

Admin at 19:44, 28 April 2023

2023-04-28T19:44:52Z

← Older revision		Revision as of 19:44, 28 April 2023
Line 131:		Line 131:


	:<h4 style="border-bottom:1px solid black;">~~WhoIs~~</h4>		:<h4 style="border-bottom:1px solid black;">WhoIsLookup</h4>
	::~~WhoIs~~ returns the domain information.		::WhoIsLookup returns the domain information.

	::{\| class="alternate01 sortable"		::{\| class="alternate01 sortable"

Admin at 19:35, 28 April 2023

2023-04-28T19:35:10Z

@@ Line 140: / Line 140: @@
 |-
 |<code>Off</code>||Deactivates domain information Lookups.
 |}

Admin at 23:38, 3 May 2022

2022-05-03T23:38:57Z

← Older revision		Revision as of 23:38, 3 May 2022
Line 146:		Line 146:
	:''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"

Admin at 17:12, 25 August 2020

2020-08-25T17:12:15Z

← Older revision		Revision as of 17:12, 25 August 2020
Line 190:		Line 190:
	:''Required.''		:''Required.''

	:The email to be verified.		:The email or domain to be verified. Domains should start with <code>@</code>.

	:{\| class="alternate01"		:{\| class="alternate01"

Admin at 21:34, 18 March 2020

2020-03-18T21:34:27Z

← Older revision		Revision as of 21:34, 18 March 2020
Line 98:		Line 98:

	:<h4 style="border-bottom:1px solid black;">VerifyMailBox</h4>		:<h4 style="border-bottom:1px solid black;">VerifyMailBox</h4>
	::~~VerifyMailBox validates~~ email mailbox.		::Validates email mailbox.

	::{\| class="alternate01 sortable"		::{\| class="alternate01 sortable"
	!Option Name !! Parameter !! Description		!Option Name !! Parameter !! Description
	\|-		\|-
	\|rowspan="2"\|'''VerifyMailBox'''\|\|<code>Express</code>\|\|'''''Default.''''' ~~Also known as fast mode.~~ Quickly validates against database of known email addresses.		\|rowspan="2"\|'''VerifyMailBox'''\|\|<code>Express</code>\|\|'''''Default.''''' Quickly validates against database of known email addresses.
	\|-		\|-
	\|<code>Premium</code>\|\|~~Also known as~~ real time ~~mode. Perform real time, live validation of~~ email ~~addresses~~.		\|<code>Premium</code>\|\|A real time check is performed to determine email deliverability.
	\|}		\|}

Admin: Admin moved page Global Email V4:Request to Global Email:Request without leaving a redirect

2019-05-23T17:46:50Z

Admin moved page Global Email V4:Request to Global Email:Request without leaving a redirect

← Older revision	Revision as of 17:46, 23 May 2019
(No difference)

Admin at 17:46, 23 May 2019

2019-05-23T17:46:40Z

← Older revision		Revision as of 17:46, 23 May 2019
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 V4 supports JSON, JSONP, REST, and XML protocols.		Global Email supports JSON, JSONP, REST, and XML protocols.

Admin at 16:10, 18 April 2019

2019-04-18T16:10:58Z

@@ 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.
 |}

Admin at 19:21, 14 March 2019

2019-03-14T19:21:12Z

← Older revision		Revision as of 19:21, 14 March 2019
Line 12:		Line 12:

	==URL==		==URL==
	{{URL-~~GlobalEmail~~}}		{{URL-GlobalEmailV4}}

Admin: Created page with "{{GlobalEmailV4Nav |InputOutputCollapse= }} {{CustomTOC}} A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required e..."

2019-03-14T19:20:56Z

Created page with "{{GlobalEmailV4Nav |InputOutputCollapse= }} {{CustomTOC}} A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required e..."

New page

{{GlobalEmailV4Nav
|InputOutputCollapse=
}}

{{CustomTOC}}

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 V4 supports JSON, JSONP, REST, and XML protocols.

==URL==
{{URL-GlobalEmail}}

==Field Names==
This is a list of the request field names and their protocol naming conventions.

{| class="alternate01 sortable"
!Field Name !! Level !! REST !! JSON
|-
|Transmission Reference||rowspan="4" valign="center"|Request||t||TransmissionReference
|-
|License Key||id||CustomerID
|-
|Options||opt||Options
|-
|Format||format||Format
|-
|Record ID||rowspan="2" valign="center"|Record|| ||RecordID
|-
|Email||email||Email
|}

==Request Elements==
The following elements set the basic options for each request. These apply to the entire request, not the individual records.

<h3 class="h3grey">Transmission Reference</h3>
:''Optional.''

:This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"TransmissionReference":"'''''string'''''"</code>
|-
|REST||<code>?t = '''''string'''''</code>
|-
|XML||<code><TransmissionReference>'''''string'''''</TransmissionReference></code>
|}

<h3 class="h3grey">License Key</h3>
:''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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CustomerID":"'''''string'''''"</code>
|-
|REST||<code>&id = '''''string'''''</code>
|-
|XML||<code><CustomerID>'''''string'''''</CustomerID></code>
|}

<h3 class="h3grey">Options</h3>
:''Optional.''

:This is a string value containing the options you set.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Options":"'''''string'''''"</code>
|-
|REST||<code>?opt = '''''string'''''</code>
|-
|XML||<code><Options>'''''string'''''</Options></code>
|}

:List options in the following format, with multiple options delimited with a ",".

:{| class="alternate01"
!Syntax
|-
|<code>''OptionName'':''Parameter'',''OptionName'':''Parameter''</code>
|}

:<h4 style="border-bottom:1px solid black;">VerifyMailBox</h4>
::VerifyMailBox validates email mailbox.

::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
|-
|rowspan="2"|'''VerifyMailBox'''||<code>Express</code>||'''''Default.''''' Also known as fast mode. Quickly validates against database of known email addresses.
|-
|<code>Premium</code>||Also known as real time mode. Perform real time, live validation of email addresses.
|}

:<h4 style="border-bottom:1px solid black;">DomainCorrection</h4>
::DomainCorrection turns on fuzzy correction on suspected email domains typos.

::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
|-
|rowspan="2"|'''DomainCorrection'''||<code>On</code>||'''''Default.''''' Activates fuzzy email domain correction if the domain is a suspected typo.
|-
|<code>Off</code>||No email domain correction.
|}

:<h4 style="border-bottom:1px solid black;">TimeToWait</h4>
::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.

::{| class="alternate01 sortable"
!Option Name !! Parameter !! Description
|-
|'''TimeToWait'''||<code># [5 - 45]</code>||'''''Default set to 25.''''' Select how long the web service will wait before it times out on an email.
|}

<h3 class="h3grey">Format</h3>
:''Optional.''

:The desired format of the response.

:{| class="alternate01"
!Protocol !! Syntax
|-
|REST||<code>&format = '''''string'''''</code>
|-
|JSON (HTTP Header)||<code>Accept: application/json</code>
|-
|XML (HTTP Header)||<code>Accept: application/xml</code>
|}

==Request Record Elements==
JSON will only contain the Records element.

{| class="alternate01"
!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.
|}

<h3 class="h3grey">RecordID</h3>
:''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.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"RecordID":"'''''string'''''"</code>
|-
|XML||<code><RecordID>'''''string'''''</RecordID></code>
|}

<h3 class="h3grey">Email</h3>
:''Required.''

:The email to be verified.

:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Email":"'''''string'''''"</code>
|-
|REST||<code>&email = '''''string'''''</code>
|-
|XML||<code><Email>'''''string'''''</Email></code>
|}

[[Category:Global Email V4]]
[[Category:Reference]]