8.3.3 Monitoring mail reception (event monitor item)
- Organization of this subsection
(1) Overview of the function
This item monitors reception of emails that match certain conditions.
(2) List of settings
|
Name |
Required |
Format |
Can specify inherited information? |
|---|---|---|---|
|
Sender |
No |
String (0 to 256 bytes) |
Yes |
|
Subject |
No |
String (0 to 512 bytes) |
Yes |
|
Message text |
No |
String (0 to 512 bytes) |
Yes |
|
Attached file save destination |
No |
String (0 to 255 bytes) |
Yes |
|
Operations for received mail in the server |
Yes |
Combo box (Do Not Delete, Delete only mail that match with monitoring condition, or Delete) |
No |
|
Mail reception interval (min.) |
No |
Numeric (1 to 1440) |
No |
|
Operations for attached files |
Yes |
Combo box (Receive attached files or Do not receive attached files) |
No |
|
Timeout period(min.) |
No |
Numeric (0 to 1440) |
No |
(3) Settings
- Sender
-
Specify partial matches for the senders from whom emails are to be monitored. Regular expressions are not supported.
- Subject
-
Specify partial matches for the subject lines with which emails are to be monitored. Regular expressions are not supported.
- Message text
-
Specify partial matches for the message text with which emails are to be monitored. Regular expressions are not supported.
- Attached file save destination
-
Specify the name of the folder where files attached to emails are stored.
If omitted, attached files are temporarily stored in the internal directory under the data path.
If Operations for attached files is set to Do not receive attached files, attached files are not stored even though you specify where to save attached files.
If the specified folder does not exist, it is created. If an attached file with the same name already exists, it is overwritten with a new attached file with that name.
- Operations for received mail in the server
-
Specify whether to delete received emails from the mail server.
- Mail reception interval (min.)
-
Specify the interval in minutes with which the mail server is queried to check email reception. If omitted, set to 10 minutes.
- Operations for attached files
-
Specify whether to receive files attached to emails.
- Timeout period(min.)
-
Specify the timeout period for the monitoring mail reception. If omitted or set to 0, the monitoring mail reception is not terminated.
When the timeout period is reached, the monitor ends abnormally (ENDE).
(4) Return values
|
Value |
Description |
|---|---|
|
-1 |
Forced termination. |
|
0 |
Emails were received and the monitoring conditions were met, or the monitor timed out because timeout was reached. |
|
1 |
Emails were received but the monitoring conditions were not met. |
|
2 |
No email was received. |
|
54 |
Cannot access the profile of mail reception (recvmailprof.ini).
|
|
58 |
An incorrect value was specified.
|
|
71 |
Failed to access the mail server.
|
|
72 |
Access was denied by the mail server.
|
|
73 |
Name resolution failed for the host name of the mail server.
|
|
75 |
The mail server denied the login.
|
|
105 |
The settings of the profile of mail reception (recvmailprof.ini) contain an error.
|
|
111 |
The profile of mail reception (recvmailprof.ini) does not exist.
|
|
Others |
Cannot access the system settings file (config.xml), insufficient resources, I/O error, or high communication load.
|
(5) Example 1
Continue monitoring until an email is received from a certain mail sender.
|
Sender |
testuser@example.com |
|
Subject |
-- |
|
Message text |
-- |
- Legend:
-
-- : Not specified
(6) Example 2
Continue monitoring until an email with a certain subject and message text is received.
|
Sender |
-- |
|
Subject |
Important |
|
Message text |
Execute jobs. |
- Legend:
-
-- : Not specified
(7) Behavior when settings are omitted
If all the settings of the sender, subject, and message text are omitted, all received emails are monitored.
(8) Settings for receiving mail
Before using the Monitoring mail reception item, you need to create a profile to be used by the Monitoring mail reception item. For details on how to create a profile, see 2.3.2 Configurations for the Monitoring mail reception item.