jpomailprof (Windows only)
- Organization of this page
Format
jpomailprof {-add|-alt|-show|-del} [-e|-k|-v] [-h logical-host-name] [-n profile-name] [-m sender-email-address] [-x reply-email-address] [-s SMTP-server-name] [-p SMTP-server-communication-port] [-i account-name-for-authentication] [-j password-for-authentication] [-r POP3-server-name] [-t POP3-server-communication-port] [-f|-q] [-o IP-address-to-be-bound]
Format 1 (for creating a profile of an email account that does not require authentication)
jpomailprof -add [-e] [-h logical-host-name] -n profile-name -m sender-email-address [-x reply-email-address] -s SMTP-server-name [-p SMTP-server-communication-port] [-o IP-address-to-be-bound]
Format 2 (for creating a profile of an email account that uses POP before SMTP authentication)
jpomailprof -add -k [-h logical-host-name] -n profile-name -m sender-email-address [-x reply-email-address] -s SMTP-server-name [-p SMTP-server-communication-port] -i account-name-for-authentication -j password-for-authentication -r POP3-server-name [-t POP3-server-communication-port] [-o IP-address-to-be-bound]
Format 3 (for creating a profile of an email account that uses SMTP-AUTH authentication)
jpomailprof -add -v [-h logical-host-name] -n profile-name -m sender-email-address [-x reply-email-address] -s SMTP-server-name [-p SMTP-server-communication-port] -i account-name-for-authentication -j password-for-authentication [-f|-q] [-o IP-address-to-be-bound]
Format 4 (for changing the profile contents)
jpomailprof -alt [-e|-k|-v] [-h logical-host-name] -n profile-name [-m sender-email-address] [-x reply-email-address] [-s SMTP-server-name] [-p SMTP-server-communication-port] [-i account-name-for-authentication] [-j password-for-authentication] [-r POP3-server-name] [-t POP3-server-communication-port] [-f|-q] [-o IP-address-to-be-bound]
Format 5 (for listing registered profiles)
jpomailprof -show [-h logical-host-name]
Format 6 (for displaying the specified profile)
jpomailprof -show [-h logical-host-name] -n profile-name
Format 7 (for deleting the specified profile)
jpomailprof -del [-h logical-host-name] -n profile-name
Description
The jpomailprof command can create, change, reference, and delete a profile necessary for sending email messages without using Outlook.
Execution privileges
Administrators privilege
Arguments
-add
Specify this argument to create a profile.
A maximum of 16 profiles can be created.
If this option is specified, the -n, -m, and -s options must also be specified.
-alt
Specify this argument to change contents of a profile. Specify the name of the profile whose contents you want to change in the -n option, and use other options to specify information you want to change.
Only the specified options can be changed.
When an option (-e, -k, or -v) used to specify the authentication method is specified, other options must also be specified. For the combinations of options that need to be specified together, see the description of the [-e|-k|-v] option.
When this option is specified, the -n option cannot be omitted.
-show
Specify this argument to display a profile.
The profile specified by the -n option is displayed. If the -n option is omitted, all registered profile names are listed.
-del
Specify this argument to delete a profile. Specify the name of the profile you want to delete in the -n option.
When this option is specified, the -n option cannot be omitted.
[-e|-k|-v]
Specify the authentication method to be used when an email message is sent.
Option |
Authentication method |
Required options |
Description |
||||
---|---|---|---|---|---|---|---|
-i |
-j |
-r |
-t |
{-f|-q} |
|||
-e |
N/A |
N |
N |
N |
N |
N |
No authentication processing is used. |
-k |
POP before SMTP |
Y |
Y |
Y |
C |
N |
POP before SMTP authentication is used. |
-v |
SMTP-AUTH |
Y |
Y |
N |
N |
C |
SMTP-AUTH authentication is used. |
- Legend
-
Y: Must be specified.
- C: Can be specified if needed. If omitted, the following values are assumed:
-
-
-t: 110
-
{-f|-q}: -f
-
N: Do not specify. If the option is specified, an error occurs.
If the -add option is specified, but this option is omitted, -e is assumed.
This option can be specified only when the -add or -alt option is specified.
-h logical-host-name
Specify the logical host name of the local host. On the host specified in this option, a profile can be created, changed, referenced, or deleted.
You can specify a character string of 1 to 255 bytes.
When executing the command on a physical host, do not specify this option and the JP1_HOSTNAME environment variable.
If the option is omitted, the logical host name specified for the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed.
-n profile-name
Specify the profile name to be created, changed, referenced, or deleted.
You can specify a character string of 1 to 64 bytes. Japanese characters are also specifiable.
The specification of alphabetic characters is case insensitive.
If a profile name contains a space, enclose the profile name with double quotation marks ("). If quotation marks are not used, the command ends abnormally.
In addition, the following profile names cannot be specified:
-
Names beginning with a space character
-
Names consisting of a single period (.)
-
Names containing any of the following characters:
\, /, :, *, ?, ", <, >, or |
-
Any of the following:
CON, PRN, AUX, CLOCK$, NUL, COM0, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT0, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9
For a physical host, depending on the installation location of JP1/AJS3, only a value 64 bytes or less can be specified as a profile name.
You must specify this option if you specify the -add, -alt, or -del option.
-m sender-email-address
Specify the sender email address.
The following characters can be used:
Alphanumeric characters, spaces, !, #, $, %, &, ', *, +, -, /, =, ?, ^, _, `, {, |, }, ~, ., (, ), <, >, [, ], :, ;, @, and ,
The number of characters that can be specified for an email address is 1 to 255 (bytes).
Validity of the specified address is not checked.
You must specify this option if you specify the -add option.
-x reply-email-address
Specify this option if you want to use a reply email address that is different from the sender email address.
The following characters can be used:
Alphanumeric characters, spaces, !, #, $, %, &, ', *, +, -, /, =, ?, ^, _, `, {, |, }, ~, ., (, ), <, >, [, ], :, ;, @, and ,
The number of characters that can be specified for an email address is 1 to 255 (bytes).
Validity of the specified address is not checked.
If you specify the -add option but omit this option, the sender email address specified by using the -m option is assumed.
-s SMTP-server-name
Specify the name of the SMTP server to which you want email sent.
The following characters can be used:
Alphanumeric characters, ., -, _, and :
You can specify a character string of 1 to 255 bytes. More than one SMTP server name cannot be specified.
You must specify this option if you specify the -add option.
-p SMTP-server-port-number
Specify the port number of the communication port on the SMTP server.
You can specify a port number from 1 to 65535.
If you specify the -add option but omit this option, TCP number 25 is used.
-i account-for-authentication
Specify the account name for POP before SMTP authentication or SMTP-AUTH authentication.
You can specify a character string of 1 to 255 bytes.
You must specify this option if you specify the -k or -v option.
-j password-for-authentication
Specify the password of the authentication account for POP before SMTP authentication or SMTP-AUTH authentication.
The password specified for this option is scrambled, and then stored in the profile.
You can specify a character string of 1 to 127 bytes.
You must specify this option if you specify the -k or -v option.
-r POP3-server-name
Specify the name of the POP3 server to be used for POP before SMTP authentication.
The following characters can be used:
Alphanumeric characters, ., -, _, and :
You can specify a character string of 1 to 255 bytes.
More than one POP3 server name cannot be specified.
This option can be specified only when the -k option is specified.
-t POP3-server-port-number
Specify the port number of the communication port for the POP3 server used for POP before SMTP authentication.
You can specify a value from 1 to 65535 as the port number.
This option can be specified only when the -k option is specified.
If you specify the -k option but omit this option, TCP number 110 is used.
[-f|-q]
Specify the authentication method for SMTP-AUTH authentication.
Option |
Authentication method |
Description |
---|---|---|
-f |
LOGIN |
SMTP-AUTH LOGIN authentication is used. |
-q |
PLAIN |
SMTP-AUTH PLAIN authentication is used. |
Note that SMTP-AUTH CRAM-MD5 authentication and SMTP-AUTH DIGEST-MD5 authentication cannot be used.
This option can be specified only when the -v option is specified.
If you specify the -v option but omit this option, -f is assumed.
-o IP-address-to-be-bound
Specify the sender IP address for communication.
If you specify 0, or specify the -add option but omit this option, the ANY binding method is used.
Both IP address formats (IPv4 and IPv6) can be specified. Specify the same IP address format as the name resolution result of the SMTP server name and the POP3 server name. Note that the name resolution result for the SMTP server name and the POP3 server name must be the same IP address format.
Notes
-
A profile is stored in the folder shown below. To execute the command, the user must have Administrators privileges and be able to read, write, and delete this folder.
profile-storage-folder\sys\prf
Replace profile-storage-folder with the value set for the WaitInfFileOutDir environment setting parameter of the [{JP1_DEFAULT|logical-host-name}\JP1AOMAGENT] definition key. For details about the WaitInfFileOutDir environment setting parameter, see 20.6.2(14) WaitInfFileOutDir (for agent processes) in the JP1/Automatic Job Management System 3 Configuration Guide.
-
If you execute this command multiple times, subsequent commands start execution after the current command finishes execution. If the processing of a command takes too much time, an error occurs, and the KAVT3847-E message is output.
-
Note the following if you execute this command in a cluster environment:
-
Execute this command when you can access the shared disk.
-
When you create a profile, do so only in the primary node. It is not necessary to create a file in the secondary node.
-
-
Do not execute this command while executing an email sending job. If you execute this command to add, update, or delete a profile while executing the email sending job, the following problems might occur:
-
It takes time for the command to end.
-
An error occurs during command execution, and the KAVT3847-E message is output.
-
An email sending job is delayed.
-
An email sending job ends abnormally.
-
Return values
0 |
Normal end |
Values other than 0 |
Abnormal end |
Example 1
The following example creates the profile1 profile, which does not require authentication:
jpomailprof -add -n profile1 -m mail@mail.com -s testsmtp.com
Example 2
The following example creates the profile2 profile, which uses POP before SMTP authentication:
jpomailprof -add -k -n profile2 -m mail@mail.com -s testsmtp.com -i id -j pass -r testpop3.com
Example 3
The following example creates the profile3 profile, which uses SMTP-AUTH PLAIN authentication:
jpomailprof -add -v -n profile3 -m mail@mail.com -s testsmtp.com -i id -j pass -q
Example 4
The following example changes the SMTP server of the profile1 profile:
jpomailprof -alt -n profile1 -s testsmtp2.com
Example 5
The following example lists the registered profiles:
jpomailprof -show
Example 6
The following example displays the specified profile1 profile:
jpomailprof -show -n profile1
Example 7
The following example deletes the specified profile1 profile:
jpomailprof -del -n profile1
Output example 1
The following example displays the specified profile1 profile:
jpomailprof -show -n profile1 SenderEmailAddress xxx@xxx.xxx ReplyEmailAddress xxx@xxx.xxx SMTPServer smtptest.com:25 POP3Server - Authentication - USER ID - Bind_IPaddress 192.168.0.2
The meaning of the output information is described below.
- SenderEmailAddress
-
The sender email address is output.
- ReplyEmailAddress
-
The reply email address is output.
- SMTPServer
-
The SMTP server to be used is output in SMTP-server-name:port-number-to-be-used format.
- POP3Server
-
The POP server to be used is output in POP3-server-name:port-number-to-be-used format. If the POP3 server is not used, - is output.
- Authentication
-
The authentication that is used an email is sent is output in the following format.
Authentication method
Character string to be output
N/A
-
POP before SMTP authentication
POP before SMTP
SMTP-AUTH PLAIN authentication
SMTP-AUTH PLAIN
SMTP-AUTH LOGIN authentication
SMTP-AUTH LOGIN
- USER ID
-
The account name used for authentication when an email is sent is output. If authentication is not performed, - is output.
- Bind_IPaddress
-
The IP address used by the sender is output. ANY is output for the ANY binding method.
Output example 2
The following example outputs all registered profile names:
jpomailprof -show PATH = C:\Program Files\HITACHI\JP1AJS2\sys\prf\ [ProfileName] test1 profile2 test3
The meaning of the output information is described below.
- PATH
-
The path to the directory in which the profile is stored is output.
- ProfileName
-
All registered profile names are output.