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 31: Line 30:
       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(
 
-
      'otherfilter.nl',
 
-
      'alias.com'
 
     )
     )
   ));
   ));
Line 60: Line 55:
       </array>
       </array>
     </destinations>
     </destinations>
-
    <aliases>
 
-
      <array>
 
-
        <item>otherfilter.nl</item>
 
-
        <item>alias.com</item>
 
-
      </array>
 
-
    </aliases>
 
   </createDomainSeRequest>
   </createDomainSeRequest>
  </openXML>
  </openXML>
Line 78: Line 67:
       <message>WARNING: Unable to deliver mail through host mail.newfilter.nl:25
       <message>WARNING: Unable to deliver mail through host mail.newfilter.nl:25
  WARNING: Unable to deliver mail through host fallback.newfilter.nl:100
  WARNING: Unable to deliver mail through host fallback.newfilter.nl:100
-
WARNING: Unable to resolve domain: newfilter.nl
 
-
WARNING: Unable to resolve domain: otherfilter.nl
 
       </message>
       </message>
     </data>
     </data>
   </reply>
   </reply>
  </openXML>
  </openXML>

Revision as of 08:50, 18 June 2012

Contents

Module SpamExperts > Create Domain

Module SpamExperts
Command name createDomainSeRequest
Use Adds a domain filter to the active SpamExperts bundle
Input
  • domainName
  • destinations
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)
    )
  ));

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>
  </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