This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

API Module SpamExperts createDomainSeRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
Line 15: Line 15:
*'''domainName'''
*'''domainName'''
*'''destinations'''
*'''destinations'''
 +
*aliases
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
Line 30: Line 31:
       array('hostname' => 'mail.newfilter.nl', 'port' => 25),
       array('hostname' => 'mail.newfilter.nl', 'port' => 25),
       array('hostname' => 'fallback.newfilter.nl', 'port' => 100)
       array('hostname' => 'fallback.newfilter.nl', 'port' => 100)
-
     )
+
     ),
 +
    'aliases' => array(
 +
      'newfilter.com',
 +
      'newfilter.net',
 +
    ),
   ));
   ));
Line 55: Line 60:
       </array>
       </array>
     </destinations>
     </destinations>
 +
    <aliases>
 +
      <array>
 +
        <item>newfilter.com</item>
 +
        <item>newfilter.net</item>
 +
      </array>
 +
    </aliases>
   </createDomainSeRequest>
   </createDomainSeRequest>
  </openXML>
  </openXML>

Revision as of 08:18, 13 December 2012

Contents

Module SpamExperts > Create Domain

Module SpamExperts
Command name createDomainSeRequest
Use Adds a domain filter to the active SpamExperts bundle
Input
  • domainName
  • destinations
  • aliases
Output Even if filter was added correctly, output might include warnings from SpamExperts

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('createDomainSeRequest')
  ->setAuth(array('username' => $username, 'password' => $password))
  ->setArgs(array(
    'domainName' => 'newfilter.nl',
    'destinations' => array(
      array('hostname' => 'mail.newfilter.nl', 'port' => 25),
      array('hostname' => 'fallback.newfilter.nl', 'port' => 100)
    ),
    'aliases' => array(
      'newfilter.com',
      'newfilter.net',
    ),
  ));

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>
  <createDomainSeRequest>
    <domainName>newfilter.nl</domainName>
    <destinations>
      <array>
        <item>
          <hostname>mail.newfilter.nl</hostname>
          <port>25</port>
        </item>
        <item>
          <hostname>fallback.newfilter.nl</hostname>
          <port>100</port>
        </item>
      </array>
    </destinations>
    <aliases>
      <array>
        <item>newfilter.com</item>
        <item>newfilter.net</item>
      </array>
    </aliases>
  </createDomainSeRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc />
    <data>
      <id>214</id>
      <message>WARNING: Unable to deliver mail through host mail.newfilter.nl:25
WARNING: Unable to deliver mail through host fallback.newfilter.nl:100
      </message>
    </data>
  </reply>
</openXML>
Views
Personal tools