API Module Email searchEmailVerificationDomainRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 12:06, 17 June 2016

Module Email > Search

Module	Email
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) 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) limit (default value: 100, maximum value: 1000) offset (default value: 0)
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 as "failed" and related domains will be suspended)

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>

@@ Line 10: / Line 10: @@
 |'''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.''
 |- style="vertical-align:top;"
 |'''Input'''
@@ Line 31: / Line 32: @@
 * 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)''
-If there are multiple domains linked to one e-mail address, multiple rows are returned.
 |}