API Module Email searchEmailVerificationDomainRequest - Revision history

WikiSysop: /* Module Email > Search */

WikiSysop — Fri, 17 Jun 2016 12:08:00 GMT

Module Email > Search

← Older revision		Revision as of 12:08, 17 June 2016
Line 27:		Line 27:
	* email		* email
	* [[API Format Handle\|handle]]		* [[API Format Handle\|handle]]
-	* status	+	* status ('failed', 'in progress', 'not verified' or 'verified')
	* description		* description
	* domain		* domain

WikiSysop: /* Raw XML */

WikiSysop — Fri, 17 Jun 2016 12:07:16 GMT

Raw XML

← Older revision		Revision as of 12:07, 17 June 2016
Line 59:		Line 59:
	<openXML>		<openXML>
	<reply>		<reply>
-	< code>0</code>	+	<nowiki><code>0</code></nowiki>
	<desc></desc>		<desc></desc>
	<data>		<data>

WikiSysop: /* Module Email > Search */

WikiSysop — Fri, 17 Jun 2016 12:06:59 GMT

Module Email > Search

← Older revision		Revision as of 12:06, 17 June 2016
Line 10:		Line 10:
	\|'''Use'''		\|'''Use'''
	\|Searches for the status of a validation request.		\|Searches for the status of a validation request.
		+	''Note: If there are multiple domains linked to one e-mail address, multiple rows are returned.''
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\|'''Input'''		\|'''Input'''
Line 31:		Line 32:
	* isSuspended		* isSuspended
	* expirationDate ''(populated if the verification is still "in progress"; indicating the date & time at which the e-mail address will be marked as "failed" and related domains will be suspended)''		* expirationDate ''(populated if the verification is still "in progress"; indicating the date & time at which the e-mail address will be marked as "failed" and related domains will be suspended)''
-	~~If there are multiple domains linked to one e-mail address, multiple rows are returned.~~
	\|}		\|}

WikiSysop: /* Module Email > Search */

WikiSysop — Fri, 17 Jun 2016 12:06:17 GMT

Module Email > Search

← Older revision		Revision as of 12:06, 17 June 2016
Line 30:		Line 30:
	* domain		* domain
	* isSuspended		* isSuspended
-	* expirationDate ''(populated if the verification is still "in progress"; indicating the date+time at which the e-mail address will be marked "failed" and ~~any~~ related ~~gTLDs~~ will be suspended)''	+	* expirationDate ''(populated if the verification is still "in progress"; indicating the date & time at which the e-mail address will be marked as "failed" and related domains will be suspended)''
	If there are multiple domains linked to one e-mail address, multiple rows are returned.		If there are multiple domains linked to one e-mail address, multiple rows are returned.
	\|}		\|}

WikiSysop: /* Module Email > Search */

WikiSysop — Fri, 17 Jun 2016 12:05:17 GMT

Module Email > Search

← Older revision		Revision as of 12:05, 17 June 2016
Line 25:		Line 25:
	\|Result set of verification details:		\|Result set of verification details:
	* email		* email
-	* handle	+	* [[API Format Handle\|handle]]
	* status		* status
	* description		* description

WikiSysop: /* Module Email > Search */

WikiSysop — Fri, 17 Jun 2016 12:05:04 GMT

Module Email > Search

← Older revision		Revision as of 12:05, 17 June 2016
Line 14:		Line 14:
	\|''(All parameters are optional; omitting all parameters will return a full list)''		\|''(All parameters are optional; omitting all parameters will return a full list)''
	* domain		* domain
-	* [[API Format ~~handle~~\|handle]]	+	* [[API Format Handle\|handle]]
	* email		* email
	* status ''(allowed values: failed - in progress - not verified - verified)''		* status ''(allowed values: failed - in progress - not verified - verified)''
	* description ''(reason for failure; allowed values: expired - bounced)''		* description ''(reason for failure; allowed values: expired - bounced)''
	* isSuspended ''(allowed values: 0 - 1)''		* isSuspended ''(allowed values: 0 - 1)''
-	*limit ''default value: 100''	+	*[[API Format Limit\|limit]] (''default value: 100, maximum value: 1000'')
-	*offset ''default value: 0''	+	*[[API Format Offset\|offset]] (''default value: 0'')
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\|'''Output'''		\|'''Output'''

WikiSysop: /* Module Email > Search */

WikiSysop — Fri, 17 Jun 2016 12:04:30 GMT

Module Email > Search

← Older revision		Revision as of 12:04, 17 June 2016
Line 14:		Line 14:
	\|''(All parameters are optional; omitting all parameters will return a full list)''		\|''(All parameters are optional; omitting all parameters will return a full list)''
	* domain		* domain
-	* handle	+	* [[API Format handle\|handle]]
	* email		* email
	* status ''(allowed values: failed - in progress - not verified - verified)''		* status ''(allowed values: failed - in progress - not verified - verified)''

WikiSysop at 12:02, 27 May 2015

WikiSysop — Wed, 27 May 2015 12:02:07 GMT

← Older revision		Revision as of 12:02, 27 May 2015
Line 19:		Line 19:
	* description ''(reason for failure; allowed values: expired - bounced)''		* description ''(reason for failure; allowed values: expired - bounced)''
	* isSuspended ''(allowed values: 0 - 1)''		* isSuspended ''(allowed values: 0 - 1)''
		+	*limit ''default value: 100''
		+	*offset ''default value: 0''
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\|'''Output'''		\|'''Output'''

WikiSysop: Created page with '==Module Email > Search== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |Email |- style="background-color:#EEEEEE;" |'''Command name''' |search…'

WikiSysop — Thu, 14 May 2015 06:04:53 GMT

Created page with '==Module Email > Search== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |Email |- style="background-color:#EEEEEE;" |'''Command name''' |search…'

New page

==Module Email > Search==
{| border="1" cellpadding="4"
|- style="background-color:#BBBBBB;"
|'''Module'''
|Email
|- style="background-color:#EEEEEE;"
|'''Command name'''
|searchEmailVerificationDomainRequest
|-
|'''Use'''
|Searches for the status of a validation request.
|- style="vertical-align:top;"
|'''Input'''
|''(All parameters are optional; omitting all parameters will return a full list)''
* domain
* handle
* email
* status ''(allowed values: failed - in progress - not verified - verified)''
* description ''(reason for failure; allowed values: expired - bounced)''
* isSuspended ''(allowed values: 0 - 1)''
|- style="vertical-align:top;"
|'''Output'''
|Result set of verification details:
* email
* handle
* status
* description
* domain
* isSuspended
* expirationDate ''(populated if the verification is still "in progress"; indicating the date+time at which the e-mail address will be marked "failed" and any related gTLDs will be suspended)''
If there are multiple domains linked to one e-mail address, multiple rows are returned.
|}

==Examples==
===Using PHP class===
$request = new OP_Request;
$request->setCommand('searchEmailVerificationDomainRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'email' => 'support@openprovider.com',
));

===Raw XML===
''Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.''
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<credentials>
<username>username</username>
<password>password</password>
</credentials>
<searchEmailVerificationDomainRequest>
<email>support@openprovider.com</email>
</searchEmailVerificationDomainRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
< code>0</code>
<desc></desc>
<data>
<results>
<array>
<item>
<email>support1@openprovider.nl</email>
<handle>AB012345-NL</handle>
<status>verified</status>
<description>-</description>
<expirationDate>0000-00-00 00:00:00</expirationDate>
<domain>openprovider1.com</domain>
<isSuspended>0</isSuspended>
</item>
<item>
<email>support2@openprovider.nl</email>
<handle>AB112345-NL</handle>
<status>failed</status>
<description>expired</description>
<expirationDate>0000-00-00 00:00:00</expirationDate>
<domain>openprovider2.com</domain>
<isSuspended>1</isSuspended>
</item>
<item>
<email>support3@openprovider.nl</email>
<handle>AB212345-NL</handle>
<status>in progress</status>
<description>-</description>
<expirationDate>2015-05-25 16:36:32</expirationDate>
<domain></domain>
<isSuspended>0</isSuspended>
</item>
</array>
</results>
<total>3</total>
</data>
</reply>
</openXML>