API Module Domain searchEmailVerificationDomainRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 05:16, 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	domain handle email status ['failed', 'in progress', 'not verified', 'verified'] description isSuspended Format: 1/0 response type: 'email' to: email address (for example: user@mail.com)
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 14: / Line 14: @@
 |
 *'''[[API Format Domain|domain]]'''
+*handle
+*email
+*status ['failed', 'in progress', 'not verified', 'verified']
+*description
+*isSuspended Format: 1/0
+* response type: 'email' to: email address (for example: user@mail.com)
 |- style="vertical-align:top;"
 |'''Output'''