9 – MODIFY
Change characteristics of one or more existing accounts.
Syntax
MODIFY username[,...]
Command Qualifiers Defaults
/CONFIRM
/FLAGS=flags
/GROUP=name
/GROUP_NAME=name
/LAST_CONNECT
/LAST_DISCONNECT
/LOG
/MESSAGE_COUNT=value
/OVERDRAFT=value
/OWNER=owner
/PASSWORD=password
/PAST_BLOCK_DAYS=value
/PRIVATE=data
/PROMPT
/PWDEXPIRED
/QUOTA=value
/RECEIVED_BYTES=value
/RECEIVED_MESSAGES=value
/TOTAL_CONNECT=value
/TOTAL_CONNECTIONS=value
9.1 – Parameters
username
Name of the account for which to make the modifications. Can
contain wild card characters.
9.2 – Description
The MODIFY command changes one or more characteristics of an
existing account. Characteristics not specified with qualifiers
in the command are left unchanged.
When the username parameter contains wild card characters, all
matching accounts within the manager's management group and
subgroups thereof will be modified. The /GROUP qualifier can
be used to further constrain which accounts are modified.
9.3 – Command Qualifiers
9.3.1 /CONFIRM
/CONFIRM
/NOCONFIRM
Prompt for positive confirmation before carrying out the
indicated operation. When wild cards are not used, /NOCONFIRM
is the default. When wild cards are used, /CONFIRM is the default
and a prompt is issued for each account to be operated upon.
Moreover, when wild cards are used, /NOCONFIRM causes only a
single prompt to be issued-it does not eliminate the prompt
altogether.
9.3.2 /FLAGS
/FLAGS=(flag[,...])
Change the usage flags associated with the account. The
recognized flags are as follows:
DISMAIL User is not allowed to receive new mail messages.
DISUSER User is not allowed to access their account.
LOCKPWD User is not allowed to change their password.
MANAGE User is allowed to manage popstore accounts.
MIGRATED Internal flag used by the PMDF migration
utilities.
PWD_ Password information is stored outside of the
ELSEWHERE popstore.
NODISMAIL User is allowed to receive new mail messages.
NODISUSER User is allowed to access their account.
NOLOCKPWD User is allowed to change their password.
NOMANAGE User is not allowed to manage popstore accounts.
NOMIGRATED Internal flag used by the PMDF migration
utilities.
NOPWD_ Password information is stored within the
ELSEWHERE popstore.
9.3.3 /GROUP
/GROUP=name
Name of a management group to constrain the operation to. This
qualifier can be used in conjunction with a username parameter
containing wild card characters so as to further constrain the
modify operation.
9.3.4 /GROUP_NAME
/GROUP_NAME=name
Change the accounts to be in the specified management group. A
manager can not change an account's management group to be a
group outside of the manager's group.
9.3.5 /LAST_CONNECT
Clear the user's last connect time field.
9.3.6 /LAST_DISCONNECT
Clear the user's last disconnect time field.
9.3.7 /LOG
/LOG
/NOLOG
When the operation is successful, output a status message stating
that the operation succeeded. Note that error messages are always
indicated. /NOLOG is the default behavior unless wild cards are
used in which case /LOG is the default.
9.3.8 /MESSAGE_COUNT
/MESSAGE_COUNT=value
Reduce the user's message count to the specified value, deleting
stored messages if necessary. The act of deleting stored message
will change the past block days field.
9.3.9 /OVERDRAFT
/OVERDRAFT=value
/NOOVERDRAFT
Change the account's overdraft quota which is the amount of
message storage by which the account can exceed its primary
message storage quota. By default, this quantity is specified
in units of kbytes; however, the SET STORAGE_UNITS command can be
used to change the units used.
The /NOOVERDRAFT qualifier is equivalent to specifying
/OVERDRAFT=0 and indicates that the account has no overdraft
quota.
The maximum value is 4 gigabytes minus 1. If the value specified
exceeds the maximum, the value is set to zero (no overdraft
quota).
9.3.10 /OWNER
/OWNER=owner
Change the accounts ownership field. The length of the string
can not exceed 40 bytes. The owner field is not used by the
popstore itself; it is generally used by humans to associate
account usernames with the actual owner of the account.
9.3.11 /PASSWORD
/PASSWORD=password
/NOPASSWORD
Change the account's password. The length of the password can not
exceed 32 bytes. Access by non-managers to the account requires
knowledge of this password. For instance, to access the account
from a POP3 client, the correct username and password associated
with the account must be supplied.
The /NOPASSWORD qualifier specifies that the account does not
require a password to access it.
Note that passwords are case sensitive. Note further that the
command line reader will convert to lower case any string not
enclosed in quotes. As such, a password containing upper case
characters must be enclosed in quotes.
9.3.12 /PAST_BLOCK_DAYS
/PAST_BLOCK_DAYS=value
Set the user's past block days field to the specified, integer
value. Changing this value clears the past block days remainder
field.
9.3.13 /PRIVATE
/PRIVATE=data
Change the site-specific account data stored in the account
profile file. The data string can not exceed a length of 64
bytes. This data is not used by the popstore itself but can be
used by site-developed procedures which access account profiles.
9.3.14 /PROMPT
/PROMPT (default)
/NOPROMPT
By default if a wildcard is used, even if /NOCONFIRM is
specified, one confirmation prompt is issued. If /NOPROMPT is
specified, there is no prompting at all.
9.3.15 /PWDEXPIRED
/PWDEXPIRED
/NOPWDEXPIRED
If /PWDEXPIRED is specified, then the account is marked as
pre-expired. This means that if password expiration is enabled
through the PASSWORD_LIFETIME option, then the user must change
their password immediately.
If /NOPWDEXPIRED is specified, then the account is marked as
not pre-expired. The time of last password change is set to the
current time. If password expiration is enabled, then the user
does not have to change the password until the PASSWORD_LIFETIME
has run out.
The default is to not change the pre-expired status of the
account.
9.3.16 /QUOTA
/QUOTA=value
/NOQUOTA
Change the account's message storage quota. The account can
continue to receive new messages so long as the storage consumed
by its currently stored messages does not exceed its message
storage quota. See also /OVERDRAFT.
A quota value of zero, as specified with /NOQUOTA or /QUOTA=0,
conveys unlimited storage. That is, to grant an account unlimited
storage set its quota to zero.
A quota value of zero, conveys unlimited storage. That is, to
grant an account unlimited storage set its quota to zero.
By default, this quantity is specified in units of kbytes;
however, the SET STORAGE_UNITS command can be used to change
the units used.
The maximum value is 4 gigabytes minus 1. If the value specified
exceeds the maximum, the value is set to zero (unlimited quota).
9.3.17 /RECEIVED_BYTES
/RECEIVED_BYTES=value
Set the cumulative count of received message bytes to the
specified, integer value. By default, this quantity is specified
in units of kbytes; however, the SET STORAGE_UNITS command can be
used to change the units used. The maximum value is 4 gigabytes
minus 1. If the value specified exceeds the maximum, the value is
set to zero.
9.3.18 /RECEIVED_MESSAGES
/RECEIVED_MESSAGES=value
Set the cumulative count of received messages to the specified,
integer value.
9.3.19 /TOTAL_CONNECT
/TOTAL_CONNECT=value
Set the user's total connect field to the specified, integer
value.
9.3.20 /TOTAL_CONNECTIONS
/TOTAL_CONNECTIONS=value
Set the user's count of total connections to the specified,
integer value.
9.4 – Examples
In the following example, the quota and password fields are
changed for the user JDOE:
popstore> MODIFY JDOE/PASSWORD="TodaY"/QUOTA=20000
10 – NOFORWARD
Remove a forwarding address.
Syntax
NOFORWARD username[,...]
Command Qualifiers Defaults
None
10.1 – Parameters
username
Username for which to remove the forwarding.
10.2 – Description
Forwarding addresses are removed with the UNFORWARD command. If
the supplied username also matches an existing popstore account,
then that account will resume receiving new mail messages.
11 – QUIT
Exit the utility.
Syntax
QUIT
Command Qualifiers Defaults
None
11.1 – Parameters
None.
11.2 – Description
The QUIT command exits the utility. The QUIT command is a synonym
for the EXIT command.
12 – RENAME
Change the username associated with an account (popstore only).
Syntax
RENAME old-username new-username
Command Qualifiers Defaults
/CONFIRM
/LOG
/PROMPT
12.1 – Parameters
old-username
The old name of the account.
new-username
The new name for the account.
12.2 – Description
The RENAME command changes the username associated with a
popstore account. Once an account is renamed, it can no longer
receive mail under the old name unless a forwarding from the
old name to the new name is also established with the FORWARD
command.
12.3 – Command Qualifiers
12.3.1 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
Prompt for positive confirmation before carrying out the
indicated operation. /NOCONFIRM is the default behavior.
12.3.2 /LOG
/LOG
/NOLOG (default)
When the operation is successful, output a status message stating
that the operation succeeded. Note that error messages are always
indicated. /NOLOG is the default behavior.
12.3.3 /PROMPT
/PROMPT (default)
/NOPROMPT
By default if a wildcard is used, even if /NOCONFIRM is
specified, one confirmation prompt is issued. If /NOPROMPT is
specified, there is no prompting at all.
12.4 – Examples
To rename the popstore account JDOE to JANEDOE, issue the
command:
popstore> RENAME JDOE JANEDOE
13 – SET
13.1 – DOMAIN
Select the user domain to manage.
Syntax
SET DOMAIN domain-name
Command Qualifiers Defaults
None
13.1.1 – Parameters
domain-name
Name of the user domain to manage.
13.1.2 – Description
By default, the DEFAULT user domain is managed with this utility.
To manage a different user domain, select that domain with the
SET DOMAIN command.
For example, to manage the EXAMPLE.COM domain, specify
popstore> SET
Using the "default" user domain
...
popstore> SET DOMAIN EXAMPLE.COM
popstore> SET
Using the "example.com" user domain
...
popstore>
13.2 – STORAGE_UNITS
Set the units used to measure byte-counted values.
Syntax
SET STORAGE_UNITS type
Command Qualifiers Defaults
None
13.2.1 – Parameters
type
Type of units to use. Must be one of BYTES, KBYTES, MBYTES, or
GBYTES.
13.2.2 – Description
By default, units of KBYTES (1024 bytes) are used when specifying
values for byte-count valued fields such as message quotas.
To select a unit of measure other than KBYTES, use the SET
STORAGE_UNITS command. BYTES selects bytes, KBYTES selects
1024 bytes, MBYTES selects 1024 KBYTES, and GBYTES selects 1024
MBYTES.
After issuing a SET STORAGE_UNITS command, all byte-count valued
numbers input on the command line will be interpreted as being
measured in the newly selected units. Note that displayed values
are displayed in the units called for by the formatting template
used to generate the display.
For example, to use units of megabytes, specify
popstore> SET STORAGE_UNITS MBYTES
13.3 – TIME_UNITS
Set the units used to measure time-valued fields.
Syntax
SET TIME_UNITS type
Command Qualifiers Defaults
None
13.3.1 – Parameters
type
Type of units to use. Must be one of SECONDS, MINUTES, HOURS, or
DAYS.
13.3.2 – Description
By default, time units of DAYS are used when specifying values
for time-valued fields. Presently, the only time-valued field
is the total connect time field which can be modified with the
/TOTAL_CONNECT qualifier of the MODIFY command.
To select a unit of measure other than DAYS, use the SET TIME_
UNITS command. After issuing a SET TIME_UNITS command, all time-
valued numbers input on the command line will be interpreted as
being measured in the newly selected units. Note that displayed
values are displayed in the units called for by the formatting
template used to generate the display. For example, to use units
of HOURS, specify
popstore> SET TIME_UNITS HOURS
14 – SHOW
Display user accounts.
Syntax
SHOW username[,...]
Command Qualifiers Defaults
/ALL
/BRIEF
/COUNT_USERS
/DOMAINS
/FORMAT_FILE=file-spec
/FORWARDINGS
/GROUP=name
/MESSAGES
/OUTPUT=file-spec
/STORE=store-type
14.1 – Parameters
username
Names of the accounts for which to display information. Wild
cards are permitted.
14.2 – Description
The SHOW command shows settings for one or more user profiles,
displays established forwarding addresses, and lists information
about messages received by users. The username parameter can
contain wild cards when displaying account information; it can
not contain wild cards when listing forwardings.
Use the SHOW/FORWARDINGS and SHOW/DOMAINS commands to generate
listings of, respectively, user e-mail forwardings and user
domains.
Use the SHOW/COUNT_USERS command to list the number of currently
defined accounts as well as any licensing limits.
14.3 – Command Qualifiers
14.3.1 /ALL
By default, only popstore accounts are displayed: MessageStore
and native accounts are not displayed. Specify /ALL to list all
accounts. Note that /ALL and /STORE=ALL are synonyms.
14.3.2 /BRIEF
Generate a brief profile or message listing. By default, the
formatting file POPMGR_PROFILE_BRIEF.TXT is used to format the
output for profile displays and POPMGR_MESSSAGE_BRIEF.TXT for
message displays. This qualifier has no effect when used in
conjunction with the /FORWARDINGS qualifier.
14.3.3 /COUNT_USERS
Display the number of currently defined user accounts as well as
the number allowed by your PMDF-POPSTORE license. Specify /ALL to
see both the popstore and MessageStore counts.
14.3.4 /DOMAINS
Generate a list of defined user domains. By default, the
formatting file POPMGR_DOMAINS.TXT is used to format the output.
14.3.5 /FORMAT_FILE
/FORMAT_FILE=file-spec
Specify a formatting file to use to format the output.
14.3.6 /FORWARDINGS
Display information about established forwarding addresses. By
default, the formatting file POPMGR_FORWARD.TXT is used to format
the output.
14.3.7 /FULL
/FULL (default)
Generate verbose output. By default, the formatting file POPMGR_
PROFILE.TXT is used to format profile information; POPMGR_
MESSAGE.TXT for message listings; POPMGR_DOMAINS.TXT for domain
listings; and, POPMGR_FORWARD.TXT for forwarding addresses. Those
formatting files are found with the other formatting files in the
PMDF_ROOT:[WWW.POPSTORE] directory.
14.3.8 /GROUP
/GROUP=name
Confine the listing to the specified management group and its
subgroups.
14.3.9 /MESSAGES
Display information on the users' messages. By default, the
formatting file POPMGR_MESSAGE.TXT is used to format the display.
14.3.10 /OUTPUT
/OUTPUT=file-spec
Write the output to the specified file rather than to the
terminal.
14.3.11 /STORE
/STORE=store-type
By default, only popstore accounts are displayed: MessageStore
and native accounts are not displayed. Specify /STORE=ALL to list
all accounts; use a store-type of MSGSTORE or IMAP to list only
MessageStore accounts; use a store-type of POPSTORE or POP to
list only popstore accounts; and, use a store-type of NATIVE to
list only profiles marked as being native.
14.4 – Examples
In the following example, full and brief listings are generated
for the DEFAULT popstore account:
popstore> SHOW DEFAULT
Username: default
Owner: Default user profile
Group:
Store Type: popstore
Usage flags:
Site-defined:
Last pwd change: No time recorded
Last connect: No time recorded
Last disconnect: No time recorded
Total connect time: 0 00:00:00
Total connections: 0
Past block days: 0
Last billing: Fri Nov 15 10:23:54 2012
Message count: 0 (0 total messages received)
Quota used: 0.00 Kbytes
Quota: 1024.00 Kbytes
Overdraft: 51.00 Kbytes
popstore> SHOW/BRIEF DEFAULT
Quota Message Quota used
Username (kbytes) Count (kbytes)
----------------------------------------------------------------
default 1024.00 0 0.00
----------------------------------------------------------------
*Note: privileged users are flagged with an asterisk
15 – TEST
Test optional, site-supplied subroutines to verify that they load
and function correctly.
Syntax
TEST/BLOCK_DAYS image-spec starting-time ending-time size
remainder
TEST/CONNECT image-spec starting-time ending-time
TEST/MESSAGE_MAPPING image-spec
TEST/PATHS path-file-spec
TEST/PROFILE_MAPPING image-spec
Command Qualifiers Defaults
/BLOCK_DAYS
/CONNECT
/MESSAGE_MAPPING
/PATHS
/PROFILE_MAPPING
15.1 – Parameters
image-spec
Executive mode logical whose translation value is the file
specification for the shareable image containing the subroutine
to test.
starting-time
Starting time value to pass to the COMPUTE_CONNECT or COMPUTE_
BLOCK_DAYS subroutine.
ending-time
Ending time value to pass to the COMPUTE_CONNECT or COMPUTE_
BLOCK_DAYS subroutine.
size
Size value to pass to the COMPUTE_BLOCK_DAYS subroutine.
remainder
Remainder value to pass to the COMPUTE_BLOCK_DAYS subroutine.
path-file-spec
File specification for the file of directory paths to check.
15.2 – Description
The TEST command provides a mechanism to test site-supplied
subroutines intended for use with the popstore. The purpose and
usage of those subroutines is described in the PMDF popstore
& MessageStore Manager's Guide. Note that the shareable image
containing the subroutine to be tested must be installed as a
known image with the DCL INSTALL CREATE command. Moreover, an
executive mode logical must be used to reference the image.
The name of that logical is specified with the image-spec
parameter. And, any logical referenced by that logical must also
be an executive mode logical. These requirements are OpenVMS
requirements and are enforced by LIB$FIND_IMAGE_SYMBOL, the run-
time library subroutine used by the popstore to dynamically load
and link to the subroutine.
Note that if you use the TEST command and then subsequently
change your subroutine, then you will need to exit the utility
and restart it before you can retest your subroutine. This is
because LIB$FIND_IMAGE_SYMBOL won't reload the subroutine a
second time. Also, when rebuilding a shareable image, be sure
to use the DCL INSTALL REPLACE command to install the new version
of the image.
The TEST/MESSAGE_MAPPING and TEST/PROFILE_MAPPING commands test,
respectively, MAP_MESSAGE_FILENAME and MAP_PROFILE_FILENAME
subroutines. The command will load the subroutine from the
specified image and then, for each stored message or profile
file, run the filename through the subroutine. The input and
output file names for each file will be displayed along with
diagnostic information, should an error occur.
The TEST/CONNECT and TEST/BLOCK_DAYS commands test, respectively,
the COMPUTE_CONNECT and COMPUTE_BLOCK_DAYS subroutines. With
each command, you can specify the values of the input arguments
to be passed to those subroutines. The results produced by
the subroutine will then be displayed. Should an error occur,
diagnostic information will be displayed.
Text files intended for use as PMDF_TABLE:POPSTORE_MESSAGE_PATHS.
or PMDF_TABLE:POPSTORE_PROFILES_PATHS. files can be tested with
the TEST /PATHS command. The command will scan the directory
trees listed in the specified file, displaying the files found in
each directory tree.
15.3 – Command Qualifiers
15.3.1 /BLOCK_DAYS
Test the COMPUTE_BLOCK_DAYS subroutine from the shareable image
image-spec.
15.3.2 /CONNECT
Test the COMPUTE_CONNECT subroutine from the shareable image
image-spec.
15.3.3 /MESSAGE_MAPPING
Test the MAP_MESSAGE_FILENAME subroutine from the shareable image
image-spec.
15.3.4 /PROFILE_MAPPING
Test the MAP_PROFILE_FILENAME subroutine from the shareable image
image-spec.
15.3.5 /PATHS
List the files from the directory trees specified in the path
file path-file-spec.
15.4 – Examples
In the following example, the MAP_PROFILE_FILENAME subroutine
described in the PMDF popstore & MessageStore Manager's Guide
is tested with the TEST/PROFILE_MAPPING command on an OpenVMS
Alpha system.
$ DEFINE/SYSTEM/EXECUTIVE_MODE POP_MAP_PROFILES -
_$ DISK3:[IMAGES]MAP_PROFILES.EXE
$ CC MAP_PROFILES.C
$ LINK/SHAREABLE=POP_MAP_PROFILES MAP_PROFILES.OBJ,SYS$INPUT:/OPT
SYMBOL_VECTOR=(map_profile_filename=PROCEDURE)
<CTRL/Z>
$ INSTALL CREATE POP_MAP_PROFILES
$ PMDF POPSTORE
popstore> TEST/PROFILE_MAPPING POP_MAP_PROFILES
PMDF_POPSTORE_PROFILES:[C.R.W]CRW.;1 -> DISK0:[PROFILES.C.R.W]CRW.;
PMDF_POPSTORE_PROFILES:[D.A.D]DAVID.;1 -> DISK0:[PROFILES.D.A.D]DAVID.;
PMDF_POPSTORE_PROFILES:[D.A.N]DAN.;1 -> DISK0:[PROFILES.D.A.N]DAN.;
PMDF_POPSTORE_PROFILES:[D.E.T]DEFAULT.;1 -> DISK0:[PROFILES.D.E.T]DEFAULT.;
PMDF_POPSTORE_PROFILES:[K.E.N]KEVIN.;1 -> DISK0:[PROFILES.K.E.N]KEVIN.;
PMDF_POPSTORE_PROFILES:[K.R.N]KRISTIN.;1 -> DISK0:[PROFILES.K.R.N]KRISTIN.;
PMDF_POPSTORE_PROFILES:[P.E.E]PEKIE.;1 -> DISK1:[PROFILES.P.E.E]PEKIE.;
PMDF_POPSTORE_PROFILES:[T.E.T]TEST.;1 -> DISK1:[PROFILES.T.E.T]TEST.;
popstore>