API Module Domain searchEmailVerificationDomainRequest
From Openprovider API documentation
(Difference between revisions)
(→Module Domain > Search domains with non-verified emails) |
(→Module Domain > Search domains with non-verified emails) |
||
| (5 intermediate revisions not shown) | |||
| Line 13: | Line 13: | ||
|'''Input''' | |'''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'') | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Output''' | |'''Output''' | ||
| Line 26: | Line 34: | ||
->setAuth(array('username' => 'username', 'password' => 'password')) | ->setAuth(array('username' => 'username', 'password' => 'password')) | ||
->setArgs(array( | ->setArgs(array( | ||
| - | 'domain | + | 'domain' => 'domain.com' |
| - | + | ||
| - | + | ||
| - | + | ||
)); | )); | ||
| Line 41: | Line 46: | ||
</credentials> | </credentials> | ||
<searchEmailVerificationDomainRequest> | <searchEmailVerificationDomainRequest> | ||
| - | <domain | + | <domain>domain.com</domain> |
| - | + | ||
| - | + | ||
| - | + | ||
</searchEmailVerificationDomainRequest> | </searchEmailVerificationDomainRequest> | ||
</openXML> | </openXML> | ||
| Line 53: | Line 55: | ||
< code>0</code> | < code>0</code> | ||
<desc></desc> | <desc></desc> | ||
| + | <data> | ||
| + | <results> | ||
| + | <array> | ||
| + | <item> | ||
| + | <email>info@openprovider.nl</email> | ||
| + | <handle>HD000001-NL</handle> | ||
| + | <status>verified</status> | ||
| + | <description>-</description> | ||
| + | <expirationDate>0000-00-00 00:00:00</expirationDate> | ||
| + | <domain>domain.com</domain> | ||
| + | <isSuspended>0</isSuspended> | ||
| + | </item> | ||
| + | </array> | ||
| + | </results> | ||
| + | <total>1</total> | ||
| + | </data> | ||
</reply> | </reply> | ||
</openXML> | </openXML> | ||
Current revision as of 06:02, 14 April 2016
Contents |
Module Domain > Search domains with non-verified emails
| Module | domain |
| Command name | searchEmailVerificationDomainRequest |
| Use | Search for domain e-mail verification status |
| Input |
|
| Output |
- |
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('searchEmailVerificationDomainRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'domain' => 'domain.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>domain.com</domain>
</searchEmailVerificationDomainRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
< code>0</code>
<desc></desc>
<data>
<results>
<array>
<item>
<email>info@openprovider.nl</email>
<handle>HD000001-NL</handle>
<status>verified</status>
<description>-</description>
<expirationDate>0000-00-00 00:00:00</expirationDate>
<domain>domain.com</domain>
<isSuspended>0</isSuspended>
</item>
</array>
</results>
<total>1</total>
</data>
</reply>
</openXML>