API

MailCleaner has two different APIs which are generally used for different purposes.

SOAP API

There are two SOAP API wsdl endpoints, available at :

https://localhost:5132/mailcleaner.wsdl
https://localhost:5132/soap/index.php?wsdl

By default, the SOAP interface is only available from localhost, but this can be opened up by adding IPs/Networks to Configuration->Services->API.

The code for these endpoints serve as the documentation, as directed below:

http://localhost:5132/mailcleaner.wsdl

Listing of the functions

/usr/mailcleaner/www/soap/mailcleaner.php

Definition of the functions

/usr/mailcleaner/www/soap/htdocs/parts/*.php 

http://localhost:5132/soap/index.php?wsdl

Listing of the functions

/www/soap/application/SoapInterface.php

Definition of the functions

/www/soap/application/MCSoap/*.php

REST API

The rest interface is defined in /www/api/.

For your convenience, you can download the API Documentation, extract it, then open index.html with a web browser.