API Module SpamExperts retrieveDomainSeRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with '==Module SpamExperts > Modify Domain== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |SpamExperts |- style="background-color:#EEEEEE;" |'''Comm…')
(→Raw XML)
 
(5 intermediate revisions not shown)
Line 1: Line 1:
-
==Module SpamExperts > Modify Domain==
+
==Module SpamExperts > Retrieve Domain==
{| border="1" cellpadding="4"
{| border="1" cellpadding="4"
|- style="background-color:#BBBBBB;"
|- style="background-color:#BBBBBB;"
Line 13: Line 13:
|'''Input'''
|'''Input'''
|
|
-
'''domainName'''
+
*domainName
-
'''bundle'''
+
*bundle (obsolete: used for old SE bundles)
-
'''withRecords'''
+
*withRecords
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
|
|
-
'''resellerId'''
+
*resellerId
-
'''isActive'''
+
*isActive
-
'''withOutgoingFilter'''
+
*withOutgoingFilter
-
'''domainName'''
+
*domainName
-
'''userEmail'''
+
*userEmail
-
'''userPassword'''
+
*userPassword
-
'''products'''
+
*smtpPassword
-
'''expirationDate'''
+
*products
 +
*expirationDate
 +
*records
|}
|}
Line 35: Line 37:
   ->setAuth(array('username' => $username, 'password' => $password))
   ->setAuth(array('username' => $username, 'password' => $password))
   ->setArgs(array(
   ->setArgs(array(
-
     'domainName' => 'newfilter.nl',
+
     'domainName' => 'filter.nl',
 +
    'bundle' => 0,
 +
    'withRecords' => 1,
   ));
   ));
Line 47: Line 51:
   </credentials>
   </credentials>
   <retrieveDomainSeRequest>
   <retrieveDomainSeRequest>
-
     <domainName>newfilter.nl</domainName>
+
     <domainName>filter.nl</domainName>
 +
    <withRecords>1</withRecords>
   </retrieveDomainSeRequest>
   </retrieveDomainSeRequest>
  </openXML>
  </openXML>
Line 57: Line 62:
     <desc />
     <desc />
     <data>
     <data>
 +
      <resellerId>123456</resellerId>
 +
      <isActive>1</isActive>
 +
      <withOutgoingFilter>0</withOutgoingFilter>
 +
      <domainName>filter.nl</domainName>
 +
      <userEmail>admin@filter.nl</userEmail>
 +
      <userPassword>qweasdzxc</userPassword>
 +
      <smtpPassword></smtpPassword>
 +
      <products>
 +
        <incoming>1</incoming>
 +
        <outgoing>0</outgoing>
 +
        <archiving>1</archiving>
 +
      </products>
 +
      <expirationDate>2017-09-01</expirationDate>
 +
      <records>
 +
        <destinations>
 +
          <array>
 +
            <item>
 +
              <hostname>mbox001.filter.nl</hostname>
 +
              <port>25</port>
 +
            </item>
 +
          </array>
 +
        </destinations>
 +
        <aliases/>
 +
        <outgoingUserIps/>
 +
      </records>
     </data>
     </data>
   </reply>
   </reply>
  </openXML>
  </openXML>

Current revision as of 04:42, 30 August 2017

Contents

Module SpamExperts > Retrieve Domain

Module SpamExperts
Command name retrieveDomainSeRequest
Use Retrieves an existing domain filter or bundle
Input
  • domainName
  • bundle (obsolete: used for old SE bundles)
  • withRecords
Output
  • resellerId
  • isActive
  • withOutgoingFilter
  • domainName
  • userEmail
  • userPassword
  • smtpPassword
  • products
  • expirationDate
  • records

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('retrieveDomainSeRequest')
  ->setAuth(array('username' => $username, 'password' => $password))
  ->setArgs(array(
    'domainName' => 'filter.nl',
    'bundle' => 0,
    'withRecords' => 1,
  ));

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>
  <retrieveDomainSeRequest>
    <domainName>filter.nl</domainName>
    <withRecords>1</withRecords>
  </retrieveDomainSeRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc />
    <data>
      <resellerId>123456</resellerId>
      <isActive>1</isActive>
      <withOutgoingFilter>0</withOutgoingFilter>
      <domainName>filter.nl</domainName>
      <userEmail>admin@filter.nl</userEmail>
      <userPassword>qweasdzxc</userPassword>
      <smtpPassword></smtpPassword>
      <products>
        <incoming>1</incoming>
        <outgoing>0</outgoing>
        <archiving>1</archiving>
      </products>
      <expirationDate>2017-09-01</expirationDate>
      <records>
        <destinations>
          <array>
            <item>
              <hostname>mbox001.filter.nl</hostname>
              <port>25</port>
            </item>
          </array>
        </destinations>
        <aliases/>
        <outgoingUserIps/>
      </records>
    </data>
  </reply>
</openXML>
Retrieved from "https://doc.openprovider.eu/API_Module_SpamExperts_retrieveDomainSeRequest"
Views
Personal tools