API Module Domain searchEmailVerificationDomainRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 05:23, 14 April 2016

Module Domain > Search domains with non-verified emails

Module	domain
Command name	searchEmailVerificationDomainRequest
Use	Search for domain e-mail verification status
Input	domainId domain email handle (Openprovider customer handle) status (failed, in progress, not verified, verified) description (-, expired, bounced, softBounced) isSuspended (0 or 1) limit default value: 100, maximum value: 1000 offset default value: 0
Output	-

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchEmailVerificationDomainRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'domain' => array(
      'name' => 'domain',
      'extension' => '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>
    <domain>
      <name>domain</name>
      <extension>com</extension>
    </domain>
  </searchEmailVerificationDomainRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc></desc>
  </reply>
</openXML>

@@ Line 13: / Line 13: @@
 |'''Input'''
 |
+*domainId
 *'''[[API Format Domain|domain]]'''
-*handle
 *email
-*status ['failed', 'in progress', 'not verified', 'verified']
+*handle (''Openprovider customer handle'')
-*description
+*status (''failed'', ''in progress'', ''not verified'', ''verified'')
-*isSuspended Format: 1/0
+*description (''-'', ''expired'', ''bounced'', ''softBounced'')
-* response type: 'email' to: email address (for example: user@mail.com)
+*isSuspended (''0'' or ''1'')
+*limit ''default value: 100, maximum value: 1000''
+*offset ''default value: 0''
 |- style="vertical-align:top;"
 |'''Output'''