API Module Email searchEmailVerificationDomainRequest
From Openprovider API documentation
(Difference between revisions)
(→Module Email > Search) |
(→Module Email > Search) |
||
| (3 intermediate revisions not shown) | |||
| 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 26: | 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 | ||
* isSuspended | * isSuspended | ||
| - | * expirationDate ''(populated if the verification is still "in progress"; indicating the date | + | * 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)'' |
| - | + | ||
|} | |} | ||
| Line 59: | Line 59: | ||
<openXML> | <openXML> | ||
<reply> | <reply> | ||
| - | < code>0</code> | + | <nowiki><code>0</code></nowiki> |
<desc></desc> | <desc></desc> | ||
<data> | <data> | ||
Current revision as of 12:08, 17 June 2016
Contents |
Module Email > Search
| Module | |
| Command name | searchEmailVerificationDomainRequest |
| Use | Searches for the status of a validation request.
Note: If there are multiple domains linked to one e-mail address, multiple rows are returned. |
| Input | (All parameters are optional; omitting all parameters will return a full list) |
| Output | Result set of verification details:
|
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>