Add a new user account to the popstore or MessageStore.
Syntax
ADD username[,...]
ADD/DOMAIN domain-name
Command Qualifiers Defaults
/CONFIRM
/DOMAIN
/FLAGS=flags
/LOG
/OVERDRAFT=value
/OWNER=owner
/PASSWORD=password
/PRIVATE=data
/PROMPT
/PWDEXPIRED
/QUOTA=value
1 – Parameters
username
Username to associate with the account or accounts being created.
2 – Description
The ADD command is used to create one or more new popstore user
accounts. An account will be created for each username supplied
on the command line. Initial settings for the accounts are taken
from the DEFAULT account. Those settings can then be overridden
with the command line qualifiers described below.
If a supplied username conflicts with an existing account, no
new account is created and an error message is issued. Note that
account usernames are case insensitive. That is the usernames
JDOE, JDOE, and JDOE are all identical.
To create a new user domain, specify the /DOMAIN qualifier. If
the domain already exists, an error will be issued. Otherwise,
it will be created and a DEFAULT user account for that domain
created. The new DEFAULT account will be a copy of the DEFAULT
account from the DEFAULT domain. To begin creating accounts in
the new domain, use the SET DOMAIN command. The maximum length of
a user domain name is 40 bytes.
NOTE
Your PMDF-POPSTORE license controls the number of popstore
user accounts which you can have at any one time. When
you reach this limit, you will not be allowed to create
additional accounts without first deleting some accounts
or obtaining a new license with an increased limit. Sites
without a PMDF-POPSTORE license are allowed to use the
popstore and create up to ten user accounts. This limit does
not include the DEFAULT account. Use the SHOW/COUNT_USERS
command to display the number of currently defined accounts
as well as the limit allowed by your license.
3 – Command Qualifiers
3.1 /CONFIRM
/CONFIRM
/NOCONFIRM (default)
Prompt for positive confirmation before carrying out the
indicated operation. /NOCONFIRM is the default behavior.
3.2 /DOMAIN
Create a new user domain. This switch can not be used in
conjunction with any of the other ADD command qualifiers.
3.3 /FLAGS
/FLAGS=(flag[,...])
Specify one or more usage flags to associate with the new
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.
3.4 /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.
3.5 /OVERDRAFT
/OVERDRAFT=value
/NOOVERDRAFT
The /OVERDRAFT qualifier specifies the amount of message storage
by which the account can exceed its message storage quota. If the
account is currently using less than its storage quota, then a
new message can be stored provided that it will not result in the
account's storage exceeding the sum of its storage and overdraft
quotas.
The /NOOVERDRAFT qualifier is equivalent to specifying
/OVERDRAFT=0 and indicates that the account has no overdraft
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 maximum value is 4 gigabytes minus 1. If the value specified
exceeds the maximum, the value is set to zero (no overdraft
quota).
3.6 /OWNER
/OWNER=owner
A text string specifying the name of the owner of the account.
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.
3.7 /PASSWORD
/PASSWORD=password
/NOPASSWORD
Specifies the account's access 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.
3.8 /PRIVATE
/PRIVATE=data
Site-specific account data can be stored in the account profile
file using this qualifier. 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.
3.9 /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.
3.10 /PWDEXPIRED
/PWDEXPIRED
/NOPWDEXPIRED (default)
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 (the default), 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.
3.11 /QUOTA
/QUOTA=value
/NOQUOTA
The /QUOTA qualifier specifies 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.
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).
4 – Examples
To create the account JDOE for Jane Doe with the password
SeCrEt, and a quota of 10 Mbytes (10240 Kbytes), use the
command
popstore> ADD JDOE/PASSWORD="SeCrEt"/OWNER="Jane Doe"/QUOTA=10240
popstore> SHOW JDOE
Username: jdoe
Owner: Jane Doe
Group:
Store Type: popstore
Usage flags:
Site-defined:
Last pwd change: Fri 15 Nov 15:33:02 2012
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 5 15:33:02 2012
Message count: 0 (0 total messages received)
Quota used: 0.00 Kbytes
Quota: 10240.00 Kbytes
Overdraft: 20.00 Kbytes