API Module Email startCustomerEmailVerificationRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 12:00, 17 June 2016

Module Email > Start

Module	Email
Command name	startCustomerEmailVerificationRequest
Use	Starts validation of an email address
Input	email
Output	id

Examples

Using PHP class

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

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>
  <startCustomerEmailVerificationRequest>
    <email>support@openprovider.nl</email>
  </startCustomerEmailVerificationRequest>
</openXML>

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

@@ Line 9: / Line 9: @@
 |-
 |'''Use'''
-|Starts the validation of an email address
+|Starts validation of an email address
 |- style="vertical-align:top;"
 |'''Input'''