Add a new user account to the popstore or MessageStore.

Syntax

add username

add -domain domain-name

Command Switches
-confirm
-domain
-flags=flags
-log
-overdraft=value
-owner=owner
-password=password
-private=data
-prompt
-pwdexpired
-quota=value

Parameters

username

Username to associate with the account or accounts being created.

domain-name

Name of the user domain to create.

Description

The add command is used to create a new popstore user accounts. Initial settings for the account are taken from the default account. Those settings can then be overridden with the command line switches 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 switch. 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.

Command Switches

-confirm

-noconfirm (default)

Prompt for positive confirmation before carrying out the indicated operation. -noconfirm is the default behavior.

-domain

Create a new user domain. This switch can not be used in conjunction with any of the other add command switches.

-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_elsewhere	Password information is stored outside of the 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_elsewhere	Password information is stored within the popstore.

-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.

-overdraft=value

-nooverdraft

The -overdraft switch 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. 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 switch 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).

-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.

-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. When -nopassword is specified, the account has no password and anyone can access it. Note that passwords are case sensitive.

-private=data

Site-specific account data can be stored in the account profile file using this switch. 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.

-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.

-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.

-quota=value

-noquota

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, 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. When -noquota is specified, the account is granted unlimited storage quota. -noquota is equivalent to -quota=0. The maximum value is 4 gigabytes minus 1. If the value specified exceeds the maximum, the value is set to zero (unlimited quota).

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 15 Nov 15:33:02 2012 Message count: 0 (0 total messages received) Quota used: 0.00 Kbytes Quota: 10240.00 Kbytes Overdraft: 20.00 Kbytes