Plesk Internal API

The Internal API of Plesk for Linux/Unix provides access to a part of core Plesk functionality. Interfaces use PHP "interface" syntax.

Third-party developers can use Internal Plesk API by providing implementations of one or more defined interfaces. The core can also provide base classes to facilitate writing a module code.

Module components using Internal Plesk API, might require implementation registration. Refer to the Registering Implementation of Interface section for details.

Component is to be registered, if it uses the following interfaces:

• Event listener
• Pluggable antivirus filter

Component can use mail handlers to handle incoming and outgoing correspondence. In this case, the handlers should be registered in the Mail Manager utility (mailmng). For implementation details, refer to the Using Mail handlers with qMail section. For other details on mail handlers, refer to the Mail Handlers section from API Reference.

If an interface does not require registration of the implementation, you can use the functionality, provided by the interface, by simply adding the following string to the beginning of your PHP files:

include pm.php;

For the detailed description of Plesk Internal API functionality, refer to the API Reference.