jssitementrybymail (registers emails as Items)
- Organization of this page
Description
This command obtains emails that users send to a specific email address, registers them as Items using the subjects, the emails, and the message IDs.
The command can also be automatically executed from the JP1/Service Support - Task Service service.
To use this command, you need to specify required information in the email definition file beforehand. For details about the email definition file, see Email definition file (jp1imss_mail_setting.conf) in Chapter 12. Definition Files.
Format
jssitementrybymail -sys [-mail]
Required execution permission
Administrator permissions
Storage folder
IM-SS-path\bin\
Arguments
-sys
Registers emails as Items. This argument is mandatory.
Enables the email notification function.
You can check whether email notification is performed in the log file (jssmailnotification_infonumber.log). number is the number of the log file. For details, see User log definition file (jp1mailnotification.conf) in Chapter 12. Definition Files.
Return values
|
Return value |
Meaning |
|---|---|
|
0 |
All the obtained emails were successfully registered as Items. |
|
1 |
All the obtained emails were successfully registered as Items. However, some of the attached files failed to be saved. |
|
2 |
Some of the obtained emails failed to be registered as Items. |
|
3 |
Some of the obtained emails failed to be registered as Items. In addition, some of the attached files failed to be saved. |
|
4 |
All the obtained emails failed to be registered as Items. |
|
5 |
All the obtained emails failed to be registered as Items. However, some of the attached files were successfully saved. |
|
6 |
An error occurred before emails were obtained. |
|
7 |
The command was executed but no emails were registered in the email server. |
Prerequisites for executing the command
-
For details about which services need to be active or inactive when this command is executed, see Status of services when commands are executed in Chapter 11. Commands.
-
Only one jssitementrybymail command can be executed at a time.
-
If you execute the jssitementrybymail command while the email server has large quantities of emails, a great load is placed on the machine. To reduce the load, execute the jssitementrybymail command at short intervals.
Remarks
-
The jssitementrybymail command will not obtain emails if one of the following is true:
-
The user does not have Administrator permissions.
-
The -sys option is not specified with the jssitementrybymail command.
-
The email definition file contains incorrect definitions.
-
The email server cannot be connected to.
-
The total size of an email exceeds 5 megabytes (the total size of an email includes the sizes of the title, message, headers, and attached files).
-
-
If you cancel the jssitementrybymail command by using Ctrl+C while the command is being executed, emails might not be registered as Items. For this reason, do not cancel the command during execution by using Ctrl+C. If you happen to do so, wait for a while and then re-execute the command.
-
While the jssitementrybymail command is being executed from the JP1/Service Support - Task Service service, if the JP1/Service Support - Task Service service stops, the command is also forcibly ended. In this case, do not stop the JP1/Service Support - Task Service service because registration of emails as Items might fail.
-
You can output the result of executing the jssitementrybymail command to a log file and check the result. For details, see User log definition file (jp1itementrybymail.conf) in Chapter 12. Definition Files.
-
If the command fails to output the file attached to an email, the command cancels outputting the file into the Item management database. If multiple files are attached to an email and the command fails to obtain any one of the files, the command does not output all the files attached to the email into the Item management database.
-
If one of the following error messages appears, a KNAB26043-E message might appear even if the command successfully registered emails as Items.
-
KNAB24003-E
-
KNAB24104-E
-
KNAB26039-E
When you eliminate the cause of the error that prompted the KNAB24003-E, KNAB24104-E, or KNAB26039-E message and execute the jssitementrybymail command again, a KNAB26036-E message might appear. This is because some of the emails were registered as Items the last time the jssitementrybymail command was executed. However, this is not a problem because the emails are registered as Items and then deleted from the email server.
-