github-jwinterm/modoboa
1
0
Fork 0
mirror of https://github.com/jwinterm/modoboa.git synced 2026-10-18 05:51:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Documentation update. Final version.

Browse Source
This commit is contained in:
tonio
2011-01-19 15:14:54 +01:00
parent 32f6202e56
commit 94b3ae8aba
1 changed files with 8 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/plugin_api.rst
+8 -11
View File
@@ -11,23 +11,20 @@ implementation provides the following possibilities:
* Access and modify administrative objects (domains, mailboxes, etc.)
* Register callback actions for specific events
The following subsections describe plugin architecture and explain
how you can create your own plugin.
How Modoboa and plugins communicate together
--------------------------------------------
Modoboa plugins are actually Django applications but with an extra file
Plugins are nothing more than Django applications with an extra file
called ``main.py``. This file contains a complete description of the
plugin:
* Admin and user parameters
* Registered events
* Menus
* Custom menu entries
According to that, a plugin can integrate Modoboa in different ways:
* Extend the usual menus by adding custom entries, they will provide direct access to the plugin core content,
* Add custom actions called when specific events are raised.
The communication between both applications is provided by
events. Modoboa offers some kind of hooks to let plugin add custom
actions.
The following subsections describe plugin architecture and explain
how you can create your own plugin.
Adding a custom plugin
----------------------