API Module Email searchEmailVerificationDomainRequest

From Openprovider API documentation

Jump to: navigation, search


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 ('failed', 'in progress', 'not verified' or 'verified')
  • 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)


Using PHP class

$request = new OP_Request;
  ->setAuth(array('username' => 'username', 'password' => 'password'))
      'email' => 'support@openprovider.com',


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"?>
<?xml version="1.0" encoding="UTF-8"?>
            <expirationDate>0000-00-00 00:00:00</expirationDate>
            <expirationDate>0000-00-00 00:00:00</expirationDate>
            <status>in progress</status>
            <expirationDate>2015-05-25 16:36:32</expirationDate>
Personal tools