A Plugin is used to implement custom functionality not included in OpenPTK. Examples included with OpenPTK Release 2.0 includes: - sendemail - Send emails and provide notifications during OpenPTK operations.
- template - Used to create a custom document (can be used as body to an email).
Syntax <Plugin id="sendemail" enabled="true" classname="org.openptk.plugin.sendemail.SendEmailPlugin">
<Properties>
<Property name="sendemail.online" value="true" />
<Property name="sendemail.file" value="/var/tmp/semail"/>
<Property name="sendemail.authen.user" value="smtpUser" />
<Property name="sendemail.authen.password" value="secret" />
<Property name="mail.debug" value="false" />
<Property name="mail.host" value="localhost"/>
<Property name="mail.transport.protocol" value="smtp" />
<Property name="mail.smtp.auth" value="false" />
<Property name="mail.smtp.port" value="25" />
<Property name="mail.smtp.quitwait" value="false" />
</Properties>
</Plugin>
ArgumentsName | Required | Description | Example |
---|
id | Yes | A unique identifier for a given Plugin. | id="sendemail" | enabled | Yes
| Indicates whether the plugin is currently enabled
| enabled="true" | classname | Yes
| A fully qualified Java classname that implements the Plugin interface.
| classname="org.openptk.plugin-sendemail.SendEmailPlugin"
|
PropertiesThere can be any number of property name/value pairs that are used as parameters to the Plugin class. There are no required Properties for an action.
|