4.2.5 Email notification plug-in

Function

This plug-in enables the connection to the SMTP server to transmit email with the specified recipient, subject, and body. In addition, editing the mail.plugin.retry.interval key of the user-specified properties file (config_user.properties) allows you to retry the operation if transmission fails.

Prerequisites for execution

• The following information is obtained from shared built-in service properties. Therefore, set the values for these items in advance in the System Settings area of the Administration window.

  • Address of the SMTP server

  • Port number

  • User ID

  • Password

  • Originator of the notification email

Cautionary notes

• Even if you do not specify the toAddress, ccAddress, and bccAddress properties, the return code will be 0.

• The mail address to be specified differs from the value of the built-in server share property. Therefore, make sure that you specify at least one of the toAddress, ccAddress, and bccAddress properties.

• If any of the toAddress, ccAddress, and bccAddress properties has an invalid email address specified, email transmission will fail to all the addresses.

• If you use machine-dependent characters or characters that are incompatible between character sets in the mailSubject or mailBody property, the characters are replaced with question marks (?) or other characters. In this scenario, either change the characters in the email, or change the encoding.

  The following characters might not be converted correctly:

  

• If the execution of a task is stopped while the plug-in is executing, the status of the task becomes Failed or Completed when the processing of the email notification plug-in finishes. The status of steps and tasks after plug-in execution has finished depends on the return code of the step and the condition for executing subsequent steps. You can set a Subsequent-step Execution Condition in the Create Step dialog box or the Edit Step dialog box.

• If you forcibly terminate a task while the plug-in is executing, the processing being executed is immediately forcibly terminated and the task enters the Failed status. A return code of 80 appears for the step in the Flow area of the Tasks window. The return code output to the task log depends on the timing with which the task was forcibly terminated.

Version

01.00.01

Tag

Mail, Notification

Return codes

Return code	Description
0	Ended normally.
65	The connection with the JP1/AO server failed. For example, the JP1/AO server might have stopped while the plug-in was executing.
66	The following user is mapped to the JP1 user: A user who does not belong to the Administrators group. A user other than the built-in Administrator who belongs to the Administrators group, in an environment with UAC enabled.
68	There is no information about the target job execution ID.
69	An environment variable of the task-processing engine could not be acquired.
70	The connection with the SMTP server failed.
78	Authentication failed.
79	Email transmission failed.
80	Task execution has stopped.
81	The plug-in was called in an invalid status.
82	The request message from the task-processing engine could not be correctly parsed.
83	The environment of the JP1/AO server is corrupted.
84	Information about the specified plug-in could not be obtained.
86	The specified property value is invalid.
127	Another error has occurred.

Properties list

The following table describes the properties.

Property key	Property name	Description	Default value	I/O type	Required
toAddress	To Addresses	Specify the email addresses of recipients to enter in the TO attribute, using no more than 1,024 characters. When specifying multiple addresses, separate them with commas.	--	Input	O
ccAddress	Cc Addresses	Specify the email addresses of recipients to enter in the CC attribute, using no more than 1,024 characters. When specifying multiple addresses, separate them with commas.	--	Input	O
bccAddress	Bcc Addresses	Specify the email addresses of recipients to enter in the BCC attribute, using no more than 1,024 characters. When specifying multiple addresses, separate them with commas.	--	Input	O
encodeType	Encoding	Specify the encoding of the email as one of the following: us-ascii iso-2022-jp shift_jis euc-jp utf-8	utf-8	Input	R
mailSubject	Subject	Specify the subject line of the email using no more than 256 characters.	--	Input	O
mailBody	Body	Specify the body text of the email using no more than 1,024 characters.	--	Input	O

Related topics

• User-specified properties file (config_user.properties) in the JP1/Automatic Operation Configuration Guide

To Page Top