2.4.2 Setting up the environment for an email reception monitoring job

(1) Procedure for setting up the environment

To set up the environment:

1. Use the environment setting parameters for event/action control to set up the environment for an email reception monitoring job.

   For details on how to do so, see (2) Procedure for setting up event/action control.

2. Set up the mail delivery function.

   For further details regarding setting up the mail delivery function, see 2.4.3 Setting up the mail delivery function.

3. Set up a mail filter application (code conversion tool), as required.

   To enable reception monitoring of emails that use multi-byte characters and MIME-encoded emails, you need to set up separately the mail filter application that will be used for linking with the mail system. For details on a mail filter application, see 2.5 Mail filtering application specifications.

4. After executing the command, restart JP1/AJS3.

   The email reception monitoring job becomes usable with the specified settings.

To Page Top

(2) Procedure for setting up event/action control

To change the definition of the environment setting parameters:

1. Execute the following command to set the environment setting parameters that define the environment for email reception monitoring jobs.

   jajs_config -k definition-key-name "environment-setting-parameter-1"=definition-content-1
   ["environment-setting-parameter-2"=definition-content-2]
   ["environment-setting-parameter-3"=definition-content-3]
   ["environment-setting-parameter-4"=definition-content-4]
   ["environment-setting-parameter-5"=definition-content-5]
   ["environment-setting-parameter-6"=definition-content-6]
   ["environment-setting-parameter-7"=definition-content-7]

   For details on the environment setting parameters required to define the environment for email reception monitoring jobs, see (3) Environment setting parameters used for email reception monitoring jobs.

   In the default environment, email reception monitoring jobs are disabled. To enable the use of email reception monitoring jobs, specify U for the ExecMode environment setting parameter.

To Page Top

(3) Environment setting parameters used for email reception monitoring jobs

The table below lists the event/action control environment setting parameters associated with email reception monitoring jobs. For details on the environment setting parameters that relate to event/action control in general, see 20.6 Setting up the event/action control environment in the JP1/Automatic Job Management System 3 Configuration Guide.

Parameters not described in the manual are for maintenance. Do not change these values.

Table 2‒7: Environment setting parameters related to an email reception monitoring job

Definition key	Environment setting parameter	Defined information
[{JP1_DEFAULT|logical-host-name}\JP1AOMAGENT\mail_link]#	"ReceiveIntervalC"=	Interval at which mail reception is monitored
	"UserName"=	User name
	"MailFileDir"=	Mail file directory name
	"MailFileName"=	Mail storage file name
	"NotMatchMailDir"=	Directory in which the file for storing unmatched email is stored
	"ReceivedMailFormat"=	Mail format for a combination of mail systems
[JP1_DEFAULT\JP1AOMAGENT\mail_link]	"ExecMode"=	Whether to use the mail system linkage function

#

Item selection in the {JP1_DEFAULT|logical-host-name} part depends on whether the host is a physical host or a logical host. If the host is a physical host, specify JP1_DEFAULT. If the host is a logical host, specify logical-host-name.

For details about the specification on a logical host, see 10.6.1(4) Cautionary notes on the execution environment for event jobs in the JP1/Automatic Job Management System 3 Administration Guide.

The following describes details of the environment setting parameter definitions:

"ReceiveIntervalC"=dword:time-interval

Specify the interval at which email reception is monitored.

Specifiable values

A hexadecimal value (in minutes) from 00000001 to 000005A0 (1 to 1,440 in decimal)

Default value

dword:0000000A (10 in decimal)

Recommended value

Set a value appropriate for the operating environment.

When the setting takes effect

The next time the JP1/AJS3 service starts

"UserName"="user-name"

Specify the name of a user for which you want to monitor the reception of email.

Note that email which is subject to reception monitoring is stored in a file that has the same name as the user name specified in this parameter. The directory in which the file is stored is specified by using the MailFileDir environment setting parameter.

Specifiable values

A character string of no more than 256 bytes

Default value

Blank

Recommended value

Set a value appropriate for the operating environment.

When the setting takes effect

The next time the JP1/AJS3 service starts

"MailFileDir"="mail-file-directory-name"

Specify the name of the mail file directory storing email for the user specified with the UserName environment setting parameter. In JP1/AJS3, email is received using the mail delivery function. Therefore, always specify /var/opt/jp1ajs2/tmp/mailbox. If you do not specify the mail file directory name, /var/opt/jp1ajs2/tmp/mailbox is assumed. For further details regarding setting up the mail delivery function, see 2.4.3 Setting up the mail delivery function.

Specifiable values

A character string of no more than 180 bytes

Default value

/var/opt/jp1ajs2/tmp/mailbox

Recommended value

/var/opt/jp1ajs2/tmp/mailbox

When the setting takes effect

The next time the JP1/AJS3 service starts

"MailFileName"="mail-storage-file-name"

Specify the full path name of the file storing the email that satisfies the monitoring condition.

Specify a file different from the mail file with the user name specified for the UserName environment setting parameter for storage in the directory specified by using the MailFileDir environment setting parameter.

Specifiable values

A character string of no more than 255 bytes

Default value

Blank

Recommended value

Set a value appropriate for the operating environment.

When the setting takes effect

The next time the JP1/AJS3 service starts

"NotMatchMailDir"="directory-in-which-file-for-storing-unmatched-email-is-stored"

Specify the full path name of the directory that contains the file storing email that does not satisfy the monitoring condition.

• Specify a different directory from the directory specified for the MailFileDir environment setting parameter.

• If you do not specify a directory name, the system deletes any email that does not satisfy the monitoring condition.

Specifiable values

A character string of no more than 180 bytes

Default value

Blank

Recommended value

Set a value appropriate for the operating environment.

When the setting takes effect

The next time the JP1/AJS3 service starts

"ReceivedMailFormat"=dword:{0|1}

Specify the data format of the mail header of the emails to be received.

The data format you specify is determined by the combination of mail system versions that will be linked.

Specifiable values

0

This data format includes the single-byte space that is automatically inserted into the mail header data of the emails to be received.

Example:Subject:ΔTITLE (Δ indicates a single-byte space.)

Specify 0 if the sendmail version for one or both of the sending and receiving hosts is earlier than 8.14.0.

1

This data format does not include the single-byte space that is automatically inserted into the mail header data of the emails to be received.

Example:Subject:TITLE

Specify 1 if the sendmail version on both the sending and receiving hosts is 8.14.0 or later.

Default value

0

Recommended value

Set a value appropriate for the operating environment.

When the setting takes effect

The next time the JP1/AJS3 service starts

Supplementary note

The following table describes the version combinations of sendmail on the sending and receiving hosts and the value to be specified for each combination.

Table 2‒8: The combinations of mail systems and the values to be specified in the ReceivedMailFormat environment setting parameter

Version of sendmail on the host receiving email	Version of sendmail on host sending email (Sending by an email sending job in JP1/AJS3 or by sendmail alone)
	Earlier than 8.14.0	8.14.0 or later
Earlier than 8.14.0	0	0
8.14.0 or later	0	1

Cautionary notes

• If you specify 0 in the ReceiveMailFormat environment setting parameter for the combination in the above table when 1 must be specified, the email reception monitoring job will not be able to detect any emails meeting the monitoring conditions defined for the job even if received.

  If you specify 1 in the ReceivedMailFormat environment setting parameter for a combination when 0 must be specified, the MLRCVSUBJECT macro variable stores the subject data of an email detected by the email reception monitoring job where a single-byte space has been inserted at the beginning.

  Because of this, specify a value that matches the combination of mail systems you are using.

• If the version of sendmail on the receiving host is 8.14.0 or later, set up the host so that it receives only the emails sent the sendmail whose version is earlier than 8.14.0, or so that it receives only the emails sent by the sendmail whose version is 8.14.0 or later.

  Also, in the ReceivedMailFormat environment setting parameter, specify a value that matches the format of the emails to be sent.

• If emails are to be sent by using, for example, the telnet command, and not by using either an email sending job or sendmail, the format of the mail header to be sent is as follows:

  - Header format corresponding to the data format used if the sendmail version is earlier than 8.14.0:

  A single-byte space is inserted between the field name and the field data.

  Example:"Subject:ΔTITLE" (Δ indicates a single-byte space.)

  - Header format corresponding to the data format used if the sendmail version is 8.14.0 or later:

  A single-byte space is not inserted between the field name and the field data.

  Example:"Subject:TITLE"

"ExecMode"="{U|N}"

Specify whether to use an email reception monitoring job.

Specifiable values

U

An email reception monitoring job is used.

N

An email reception monitoring job is not used.

Default value

N

Recommended value

Set a value appropriate for the operating environment.

When the setting takes effect

The next time the JP1/AJS3 service starts

To Page Top