Email environment definition file (jimmail.conf)
- Organization of this page
Format
Charset=email-character-encoding From=sender-email-address DefaultTo=default-destination-email-address[,default-destination-email-address...] SmtpServer=SMTP-server-name SmtpPort=SMTP-port-number AuthMethod=authentication-method-when-sending-email SmtpAuthPort=SMTP-AUTH-authentication-submission-port-number Pop3Server=POP3-server-name Pop3Port=POP3-port-number AuthUser=authentication-account-name AuthPassword=authentication-password ConnectTimeout=network-connection-timeout-period SoTimeout=communication-timeout-period MailSubjectCutting=email-subject-drop-setting MailNewLine=email-linefeed-code
File
jimmail.conf (email environment definition file)
jimmail.conf.model (model file of the email environment definition file)
Storage directory
- In Windows
-
- For a physical host:
-
Console-path\conf\mail
- For a logical host:
-
shared-folder\JP1Cons\conf\mail
Description
The email environment definition file is a definition file that sets information required to send an email, including email server host names, authentication methods, authentication account names, and passwords.
When the definitions are applied
The definition takes effect when the jimmail command is executed.
Information that is specified
The following rules are applied to the email environment definition file:
-
Each entry must be specified on a line in parameter-name=setting-value format. On each line, parameter-name and setting-value are separated by the first equal sign (0x3d).
-
Only CR (0x0d) + LF (0x0a) is treated as a line break. If line break codes other than CRLF are contained, the line break codes are converted to CRLF before output when a password is set by using the jimmailpasswd command.
-
The parameter name is case sensitive.
-
A line beginning with # (0x23) or Δ# is a comment statement. However, if there is a character other than a single-byte space (0x20) or a tab (0x09) before #, the line is not treated as a comment statement (Δ indicates a single-byte space or a tab).
-
Single-byte spaces or tabs are treated as follows (Δ indicates a single-byte space or a tab):
-
Single-byte spaces or tabs immediately before or after a parameter name are ignored.
Example: Δparameter-nameΔ=setting-value
-
Single-byte spaces or tabs immediately before or after the setting value are ignored. However, they are treated as characters and not ignored for the AuthPassword parameter.
Example: parameter-name=Δsetting-valueΔ
-
-
If an invalid parameter is written, an error occurs. Also, if there is no equal sign (=) after a parameter name, an error occurs.
- Charset=email-character-encoding
-
Defines the character encoding for the subject and text of an email to send.
The character encoding is not case sensitive.
The following table lists the initial values for the Charset parameter, and a value to be set if the value for the Charset parameter is not obtained.
Table 2‒69: Initial values for the Charset parameter and setting values when the value could not be obtained Environment
Initial value
Setting value when the value could not be obtained
Japanese environment
iso-2022-jp
iso-8859-1
Non-Japanese environment
iso-8859-1
iso-8859-1
The following table lists the character encoding that can be specified for Charset.
If you specify character encoding that cannot be specified, the setting value in the above table is assumed.
Table 2‒70: Character encoding that can be specified for Charset Character encoding
Description
iso-2022-jp
JIS encoding
shift_jis
Shift-JIS encoding
euc-jp
EUC encoding
utf-8
UTF-8 encoding
iso-8859-1
Latin1 encoding
us-ascii
ANSI encoding
GB18030
GB18030 encoding (GBK range only)
Others
Cannot be specified
If there is no parameter, the parameter does not have a value, or character encoding that cannot be specified for the parameter is defined, the KAVB8715-W message is output, and the initial value is set.
- From=source-email-address
-
Defines the source email address of an email notification.
The initial value is the null character ("").
Only one source email address can be defined.
This item cannot be omitted.
Specify the source email address from 1 to 256 bytes.
The following table lists the permitted characters.
Table 2‒71: Character encoding that can be used for From Characters that can be used
Description
One-byte alphanumeric characters
0 to 9, and a to z
@
At mark (0x40)
.
Period (0x2e)
-
Hyphen (0x2d)
_
Underscore (0x5f)
If there is no essential parameter, the parameter does not have a value, a character that cannot be specified for a parameter is defined, a parameter is not in the RFC822 format, or a parameter is exceeding the maximum length, the KAVB8714-E message is output and the operation terminates abnormally.
- DefaultTo=default-destination-email-address[,default-destination-email-address...]
-
Defines the default destination email address.
The initial value is the null character ("").
You can define 20 destination email addresses. To specify multiple email addresses, separate them by a comma (,).
A single-byte space or tab between an email address and a comma (,) is ignored.
Consecutive commas (,) are treated as a comma, and commas at the beginning and at the end are ignored. If the same email address is specified more than once, the email message is sent to the specified address only once.
This parameter can be omitted. If omitted, the -to option of the jimmail command must be specified.
If both the DefaultTo parameter and the -to option of the jimmail command are specified, the -to option is prioritized.
Specify the destination email address from 1 to 256 bytes.
The characters that can be used for the source email address can be used.
If unusable characters are specified, the parameter is not in the RFC822 format, or the parameter exceeds the maximum length, the KAVB8714-E message is output, and the operation terminates abnormally.
Also, if neither the DefaultTo parameter nor the -to option of the jimmail command is specified, the KAVB8712-E message is output, and the operation terminates abnormally.
- SmtpServer=SMTP-server-name
-
Defines the host name or the IP address of the SMTP server to connect when sending an email. Configure one of the following files to enable successful host name resolution of SMTP-server-name:
-
The jp1hosts file in JP1/Base on the manager host
-
The jp1hosts2 file in JP1/Base on the manager host
-
The hosts file or DNS
For the IP address, only IPv4 addresses can be specified. IPv6 addresses cannot be specified.
The initial value of the SmtpServer parameter is the null character ("").
Specify only one SMTP server name across the system.
This parameter cannot be omitted.
Specify 1 to 255 of one-byte characters for the host name.
If there is no essential parameter, the parameter does not have a value, a character that cannot be used for a parameter is defined, or the parameter exceeds the maximum length, the KAVB8714-E message is output, and the operation terminates abnormally.
-
- SmtpPort=SMTP-port-number
-
Defines the port number of the communication port for the SMTP server.
The initial value for the SmtpPort parameter is 25. If you could not obtain the value, 25 is assumed. Specify the port number from 1 to 65535.
If you define NONE or POP for AuthMethod, this item takes effect.
If there is no parameter, the parameter does not have a value, a character other than a numeric value is specified for the parameter, or a value outside the range is specified for the parameter, the KAVB8715-W message is output. The command continues processing, assuming the initial value.
- AuthMethod=authentication-method-for-sending-email
-
Defines the authentication method for sending an email.
This parameter cannot be omitted.
Use the value listed in the table below for the authentication method. The initial value is NONE.
Table 2‒72: Authentication method for AuthMethod Value of AuthMethod
Authentication method
NONE
No authentication
POP
POP before SMTP authentication
SMTP
SMTP-AUTH authentication
Depending on the authentication method for sending an email, the items that must be set for the email environment definition file vary.
If there is no essential parameter, the parameter does not have a value, or a value outside the range is specified for the parameter, the KAVB8714-E message is output, and the operation terminates abnormally.
The following table lists the setting items for each AuthMethod value.
Table 2‒73: Setting items when AuthMethod is NONE Parameter name
Setting
Omission
Value assumed when omitted
Charset
Y
Possible
iso-8859-1
From
Y
Impossible
--
DefaultTo
Y
Possible
""
AuthMethod
Y
Impossible
--
SmtpServer
Y
Impossible
--
SmtpPort
Y
Possible
25
SmtpAuthPort
N
--
--
Pop3Server
N
--
--
Pop3Port
N
--
--
AuthUser
N
--
--
AuthPassword
N
--
--
ConnectTimeout
Y
Possible
10,000
SoTimeout
Y
Possible
10,000
MailSubjectCutting
Y
Possible
OFF
MailNewLine
Y
Possible
CRLF
- Legend:
-
Y: Must be set.
N: Not necessary to be set.
Table 2‒74: Setting items when AuthMethod is POP Parameter name
Setting
Omission
Value assumed when omitted
Charset
Y
Possible
iso-8859-1
From
Y
Impossible
--
DefaultTo
Y
Possible
""
AuthMethod
Y
Impossible
--
SmtpServer
Y
Impossible
--
SmtpPort
Y
Possible
25
SmtpAuthPort
N
--
--
Pop3Server
Y
Impossible
--
Pop3Port
Y
Possible
110
AuthUser
Y
Impossible
--
AuthPassword
Y
Impossible
--
ConnectTimeout
Y
Possible
10,000
SoTimeout
Y
Possible
10,000
MailSubjectCutting
Y
Possible
OFF
MailNewLine
Y
Possible
CRLF
- Legend:
-
Y: Must be set.
N: Not necessary to be set.
Table 2‒75: Setting items when AuthMethod is SMTP Parameter name
Setting
Omission
Value assumed when omitted
Charset
Y
Possible
iso-8859-1
From
Y
Impossible
--
DefaultTo
Y
Possible
""
AuthMethod
Y
Impossible
--
SmtpServer
Y
Impossible
--
SmtpPort
N
--
--
SmtpAuthPort
Y
Impossible
587
Pop3Server
N
--
--
Pop3Port
N
--
--
AuthUser
Y
Impossible
--
AuthPassword
Y
Impossible
--
ConnectTimeout
Y
Possible
10,000
SoTimeout
Y
Possible
10,000
MailSubjectCutting
Y
Possible
OFF
MailNewLine
Y
Possible
CRLF
- Legend:
-
Y: Must be set.
N: Not necessary to be set.
- SmtpAuthPort=SMTP-AUTH-authentication-submission-port-number
-
Defines the submission port number of the communication port for the SMTP-AUTH authentication. The initial value is 587. If you cannot obtain the value, 587 is assumed. Specify a value from 1 to 65535.
When using the SMTP-AUTH authentication, specify the number of the destination port used by the SMTP server to connect for the SmtpAuthPort parameter if the connection email server does not use the submission port.
When you define SMTP for AuthMethod, this item takes effect.
If this parameter does not exist, the parameter does not have a value, characters other than numeric values are specified for the parameter, or a value outside the range is specified for the parameter, the KAVB8715-W message is output. The command continues processing, assuming the initial value.
- Pop3Server=POP3-server-name
-
Defines the host name or the IP address of the POP3 server to be used for POP before SMTP authentication. Configure one of the following files to enable successful host name resolution of POP3-server-name:
-
The jp1hosts file in JP1/Base on the manager host
-
The jp1hosts2 file in JP1/Base on the manager host
-
The hosts file or DNS
For the IP address, IPv4 addresses can be specified. IPv6 addresses cannot be specified.
If the email server serves as both the SMTP server and the POP3 server, specify the SMTP server name specified for SmtpServer.
Specify only one POP3 server name across the system.
Specify 1 to 255 one-byte characters as the host name of the POP3 server. The initial value is the null character (""). Characters you can use as the host name of the POP3 server are the characters that can be used for the host name of the SMTP server.
If you define POP for AuthMethod, this item takes effect. When it takes effect, you must specify this parameter.
If there is no essential parameter, the parameter does not have a value, characters that cannot be specified for the parameter are specified, or the parameter exceeds the maximum length, the KAVB8714-E message is output, and the operation terminates abnormally.
-
- Pop3Port=POP3-port-number
-
Defines the port number of the communication port for the POP3 server to use for the POP before SMTP authentication.
The initial value for the parameter is 110. If you cannot obtain the value, 110 is assumed. Specify a value from 1 to 65535 for the port number.
If you define POP for AuthMethod, this item takes effect.
If there is no parameter, the parameter does not have a value, characters other than numeric values are specified for the parameter, or a value outside the range is specified for the parameter, the KAVB8715-W is output, and the initial value is assumed.
- AuthUser=authentication-account-name
-
The AuthUser parameter defines the authentication account name to use for the POP before SMTP or SMTP-AUTH authentication.
Specify 1 to 255 one-byte characters for the authentication account name.
The initial value is the null character ("").
If you specify POP or SMTP for the AuthMethod parameter, this item takes effect.
If there is no essential parameter, the parameter does not have a value, characters (multi-byte) that cannot be used for the parameter are defined, or the parameter exceeds the maximum length, the KAVB8714-E message is output, and the operation terminates abnormally.
- AuthPassword=authentication-password
-
For the AuthPassword parameter, the authentication password for the POP before SMTP or SMTP-AUTH authentication is set.
The authentication password for the AuthPassword parameter is set by using the jimmailpasswd command.
If you edit the email environment definition file, and set a password in plain text for the AuthPassword parameter, you cannot log in to the email server because the authentication password does not match when connecting to the email server.
If you specify POP or SMTP for the AuthMethod parameter, this item takes effect.
If there is no essential parameter, the parameter does not have a value, characters (multi-byte) that cannot be used for the parameter are specified, or the parameter exceeds the maximum length, the KAVB8714-E message is output, and the operation terminates abnormally.
- ConnectTimeout=network-connection-timeout-period
-
For the ConnectTimeout parameter, define the timeout period in milliseconds for waiting until connection between the SMTP and POP3 servers is established. The initial value is 10,000 milliseconds (10 seconds).
Specify 1,000 to 3,600,000 (1 to 3,600 seconds) for the timeout period.
Change this value only when a timeout occurs with the initial value according to the operating environment.
If there is no parameter, the parameter does not have a value, a character string other than numeric characters is specified for the parameter, or a value outside the range is specified for the parameter, the KAVB8715-W message is output, and the initial value is assumed.
- SoTimeout=communication-timeout-period
-
Define the timeout period in milliseconds until a response is received from the SMTP and POP3 servers for the SoTimeout parameter. The initial value is 10,000 milliseconds (10 seconds).
Specify a value from 1,000 to 3,600,000 (1 to 3,600 seconds) as the timeout period.
Only when a communication timeout error occurs with the initial value, change the value according to the operating environment.
If there is no parameter, the parameter does not have a value, a character string other than numeric characters is specified for the parameter, or a value outside the range is specified for the parameter, the KAVB8715-W message is output, and the initial value is assumed.
- MailSubjectCutting=email-subject-drop-setting
-
For the MailSubjectCutting parameter, define whether to drop the email subject, and forcibly send the email if the email subject exceeds the maximum length when sending the email.
-
When OFF is set, the email subject is not dropped, and the jimmail command terminates abnormally.
-
When ON is set, drops the email subject according to the character encoding specified for the Charset parameter within 512 bytes, and continues sending the email.
The initial value is OFF. The setting value is not case sensitive.
If there is no parameter, the parameter does not have a value, or a value other than ON and OFF is specified, the KAVB8715-W message is output, and the initial value is assumed.
-
- MailNewLine=email-linefeed-code
-
For the MailNewLine parameter, define the linefeed code to be used in the text of an email. The jimmail command replaces the linefeed code (\n) specified for the optional argument of the command with the linefeed code specified for this parameter before sending the email. The initial value is CRLF.
The setting value is not case sensitive.
The linefeed code is regulated as CRLF in RFC. Do not change the initial value if you do not have specific reasons. On some email servers, if linefeed codes other than CRLF are used, email messages might not be sent, or a line in email contents might not be broken.
The linefeed codes are defined by using the values listed in the following table.
Table 2‒76: Setting value for MailNewLine Setting value
Description
CRLF
CR (0x0d) + LF (0x0a)
LF
LF (0x0a)
CR
CR (0x0d)
If there is no parameter, the parameter does not have a value, or a value outside the range is defined for the parameter, the KAVB8715-W message is output, and the initial value is assumed.
Example
The following is the email environment definition file for a Japanese environment immediately after installation:
Charset=iso-2022-jp From= DefaultTo= SmtpServer= SmtpPort=25 AuthMethod=NONE SmtpAuthPort=587 Pop3Server= Pop3Port=110 AuthUser= AuthPassword= ConnectTimeout=10000 SoTimeout=10000 MailSubjectCutting=OFF MailNewLine=CRLF
The following is the email environment definition file for a non-Japanese environment immediately after installation:
Charset=iso-8859-1 From= DefaultTo= SmtpServer= SmtpPort=25 AuthMethod=NONE SmtpAuthPort=587 Pop3Server= Pop3Port=110 AuthUser= AuthPassword= ConnectTimeout=10000 SoTimeout=10000 MailSubjectCutting=OFF MailNewLine=CRLF