API Module SpamExperts createDomainSeRequest
From Openprovider API documentation
(Difference between revisions)
(→Raw XML) |
|||
(5 intermediate revisions not shown) | |||
Line 15: | Line 15: | ||
*'''domainName''' | *'''domainName''' | ||
*'''destinations''' | *'''destinations''' | ||
+ | *'''products''' | ||
*aliases | *aliases | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
Line 31: | Line 32: | ||
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) | ||
+ | ), | ||
+ | 'products' => array( | ||
+ | 'incoming' => 1, | ||
+ | 'outgoing' => 1, | ||
+ | 'archiving' => 0, | ||
), | ), | ||
'aliases' => array( | 'aliases' => array( | ||
- | ' | + | 'newfilter.com', |
- | ' | + | 'newfilter.net', |
- | ) | + | ), |
)); | )); | ||
Line 60: | Line 66: | ||
</array> | </array> | ||
</destinations> | </destinations> | ||
+ | <products> | ||
+ | <incoming>1</incoming> | ||
+ | <outgoing>1</outgoing> | ||
+ | <archiving>0</archiving> | ||
+ | </products> | ||
<aliases> | <aliases> | ||
<array> | <array> | ||
- | <item> | + | <item>newfilter.com</item> |
- | <item> | + | <item>newfilter.net</item> |
</array> | </array> | ||
</aliases> | </aliases> | ||
Line 78: | Line 89: | ||
<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 | ||
- | |||
- | |||
</message> | </message> | ||
</data> | </data> | ||
</reply> | </reply> | ||
</openXML> | </openXML> |
Current revision as of 11:57, 22 August 2018
Contents |
Module SpamExperts > Create Domain
Module | SpamExperts |
Command name | createDomainSeRequest |
Use | Adds a domain filter to the active SpamExperts bundle |
Input |
|
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) ), 'products' => array( 'incoming' => 1, 'outgoing' => 1, 'archiving' => 0, ), '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> <products> <incoming>1</incoming> <outgoing>1</outgoing> <archiving>0</archiving> </products> <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>