Difference between revisions of "OS4X plugin mail to recipient"
Jump to navigation
Jump to search
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | [[Category:Plugins]] | |
| − | + | == Purpose == | |
| + | This plugin sends an HTML information email to the recipient of an OS4X Enterprise job. The information is based on the XML file transferred. | ||
| − | == | + | == Requirements == |
| − | + | * File <code>/etc/os4x.conf</code> or configuration file referenced by environment variable <code>$OS4X_CFGFILE</code> | |
| − | * | + | * Program <code>xsltproc</code> |
| − | + | * XSL transformation file (<code>send_email.xsl</code>) | |
| − | * <code>xsltproc</code> | + | * installed and configured mail transfer agent |
| − | * | ||
| − | * | ||
* <code>os4x_extract_recipient_email_from_xml</code> | * <code>os4x_extract_recipient_email_from_xml</code> | ||
| − | == | + | == Configuration == |
| + | This plugin is a script, which is therefore easy to edit. | ||
| − | + | The variables that usually need to be configured are defined in the head of the script: | |
| − | |||
| − | |||
XSL_FILE=/opt/os4x/plugins/send_email.xsl | XSL_FILE=/opt/os4x/plugins/send_email.xsl | ||
MYSQL=/usr/bin/mysql | MYSQL=/usr/bin/mysql | ||
| − | == | + | == Return codes == |
| − | 0: | + | *0: everything OK |
| − | + | *2: error calling program <code>os4x_extract_recipient_email_from_xml</code> | |
| − | 2: | + | *3: Email address cannot be determined |
| − | + | *other values: return code of <code>xsltproc</code> | |
| − | 3: | ||
| − | |||
| − | |||
Latest revision as of 08:26, 29 July 2024
Purpose
This plugin sends an HTML information email to the recipient of an OS4X Enterprise job. The information is based on the XML file transferred.
Requirements
- File
/etc/os4x.confor configuration file referenced by environment variable$OS4X_CFGFILE - Program
xsltproc - XSL transformation file (
send_email.xsl) - installed and configured mail transfer agent
os4x_extract_recipient_email_from_xml
Configuration
This plugin is a script, which is therefore easy to edit.
The variables that usually need to be configured are defined in the head of the script:
XSL_FILE=/opt/os4x/plugins/send_email.xsl MYSQL=/usr/bin/mysql
Return codes
- 0: everything OK
- 2: error calling program
os4x_extract_recipient_email_from_xml - 3: Email address cannot be determined
- other values: return code of
xsltproc