Job Management Partner 1/Automatic Job Management System 3 Linkage Guide

2.4.1 Mail Filter Application Specifications

This subsection describes the specifications of a mail filter application.

Organization of this subsection

(1) Files used by the mail filter application

(2) Return values from the mail filter application

(1) Files used by the mail filter application

The following table lists the files the mail filter application uses:

Table 2-5 Files used by the mail filter application

No. File name Description

1 /opt/jp1ajs2/usrtools/converter Name of the mail filter application.

2 /opt/jp1ajs2/usrtools/converterin Input file.
This file stores a single email message JP1/AJS3 extracts from the email.
JP1/AJS3 stores email in this file before starting the mail filter application.

3 /opt/jp1ajs2/usrtools/converterout Output file.
This file stores the email converted by the mail filter application.
Once the mail filter application terminates normally, JP1/AJS3 extracts the email from this file and determines whether it satisfies the monitoring condition.

Specify the file name listed in No. 1 of the table as the name of the mail filter application. Specify the name listed in No. 2 of the table for the input file for the mail filter application. Specify the name listed in No. 3 of the table for the file to which the converted email is output.

If you specify a logical host name, the file names are assumed as follows:

Example: If the specified logical host name is HOSTNAME1

Mail filter application name: /opt/jp1ajs2/usrtools/converterHOSTNAME1

Input file name: /opt/jp1ajs2/usrtools/converterinHOSTNAME1

Output file name: /opt/jp1ajs2/usrtools/converteroutHOSTNAME1

Note: Do not include a space between /opt/jp1ajs2/usrtools/converter and the logical host name, between /opt/jp1ajs2/usrtools/converterin and the logical host name, or between /opt/jp1ajs2/usrtools/converterout and the logical host name.

No.	File name	Description
1	/opt/jp1ajs2/usrtools/converter	Name of the mail filter application.
2	/opt/jp1ajs2/usrtools/converterin	Input file. This file stores a single email message JP1/AJS3 extracts from the email. JP1/AJS3 stores email in this file before starting the mail filter application.
3	/opt/jp1ajs2/usrtools/converterout	Output file. This file stores the email converted by the mail filter application. Once the mail filter application terminates normally, JP1/AJS3 extracts the email from this file and determines whether it satisfies the monitoring condition.

(2) Return values from the mail filter application

The mail filter application must pass one of the return values below to JP1/AJS3 upon the completion of conversion.

JP1/AJS3 behaves differently depending on the passed return value. The following table shows return values from the mail filter application and corresponding JP1/AJS3 action:

Table 2-6 Return values and corresponding JP1/AJS3 action

Return value Meaning JP1/AJS3 action

0 Ended normally Extracts the email from the file output by the mail filter application and determines whether it satisfies the monitoring condition.
Uses the mail filter application to convert the next email.

Non-0 Ended abnormally Outputs a message and disables the mail system linkage function.
Stores the email in the error email file.
Does not convert the next mail until JP1/AJS3 is restarted.

How the mail filter application passes a return value depends on the language in which it is created. Use either of the following:

For the shell language: exit command

For the C language: exit() system call

Return value	Meaning	JP1/AJS3 action
0	Ended normally	Extracts the email from the file output by the mail filter application and determines whether it satisfies the monitoring condition. Uses the mail filter application to convert the next email.
Non-0	Ended abnormally	Outputs a message and disables the mail system linkage function. Stores the email in the error email file. Does not convert the next mail until JP1/AJS3 is restarted.

[Contents][Back][Next]

[Trademarks]