Messaging Server Administrator's Guide: Command-line Utilities

Appendix A Command-line Utilities

Netscape Messaging Server provides a set of command-line utilities in addition to its graphical user interface. This appendix describes utilities for Messaging Server installation, migration, starting, stopping, administration, message management, problem recovery, monitoring, and reporting.

Each command-line utility has a set of options. Please note that these options might change in future releases as product functionality evolves.

This appendix includes the following sections:

Overview of Command-Line Utilities

Command-Line Utilities--General Information

Messaging Server Utilities--Descriptions

Alarm Attributes

There is a separate set of utilities used to migrate from a Unix sendmail messaging environment to Netscape Messaging Server 4.x. The sendmail utilities are described in Appendix B. The Messaging Multiplexor and Mailstone components also have their own set of utilities. The Messaging Multiplexor utilities are described in Chapter 13. The Mailstone utilities are described in the Mailstone document.

Overview of Command-Line Utilities

This overview briefly describes the Netscape Messaging Server command-line utilities. This section contains two tables:

Table A.1 groups the installation, message management, problem recovery, monitoring, and reporting utilities into categories according to their function and purpose.

Table A.2 describes the installation, message management, problem recovery, monitoring, and reporting utilities in alphabetical order. For complete information about each utility, see Messaging Server Utilities--Descriptions.

Table A.1 Command-line utilities by category


Category	Command-line Utilities
Installation and migration	MoveUser, qconvert, upgrade
Management	configutil, imscripter, mboxutil, NscpMsg, processq
Recovery	deliver, reconstruct
Background and daily tasks	stored
Monitoring and reporting	counterutil, hashdir, mailq, quota, readership

Table A.2 Command-line utilities and what they do


Command	What it does
configutil	Displays and makes changes to configuration information stored in the Directory Server or local configuration file.
counterutil	Displays all counters in a counter object. Monitors a counter object.
deliver	Delivers mail to a message store accessible by IMAP or POP.
hashdir	Identifies the directory that contains the message store for a particular user.
imscripter	The IMAP server protocol scripting tool. Executes a command or sequence of commands.
mailq	Checks the mail queue and reports the number of messages awaiting delivery.
mboxutil	Lists, creates, deletes, renames, or moves mailboxes.
MoveUser	Moves messages in a user's mailbox from one Messaging Server to another.
NscpMsg (Unix)	Starts and stops Messaging Server and runs recovery utilities.
processq	Manually delivers queued messages from the mail queue.
qconvert	Converts the Netscape Messaging Server 3.x message queue to the 4.x format.
quota	Reports quota usage.
readership	Collects readership information on mailboxes.
reconstruct	Reconstructs mailboxes that have been damaged or corrupted.
stored	Performs background and daily tasks, expunges, and erases messages stored on disk.
upgrade	Converts Messaging Server mailboxes stored in 3.x format on a 3.x server to mailboxes in 4.x format on a 4.x server.

Command-Line Utilities--General Information

This section provides general information about using Netscape Messaging Server command-line utilities.

Tip: A note about internationalization: If these utilities do not work correctly in your native environment, check the setting of the LANG environment variable.

Messaging Server File Locations

Messaging Server files are located in the following locations:

Table A.3 Command-line utilities location


Location	Utilities
server-root/bin/msg/ admin/bin	configutil, counterutil, deliver (NT), hashdir, imscripter, mailq (NT), mboxutil, MoveUser, NscpMsg, processq (NT), qconvert, quota, readership, reconstruct, stored, upgrade
server-root/bin/msg/store/bin	deliver (Unix)
/bin/mailq	mailq (Unix)
/usr/lib/processq	processq (Unix)

Location of Configuration Data

All user and group configuration information is stored on the LDAP Directory Server.

Most Messaging Server configuration data is also stored on the LDAP server. Some Messaging Server configuration information is stored in a local file named configdb on the Messaging Server. The configdb file contains the following kinds of configuration information:

Start up (bootstrap) information needed to locate the configuration data on the LDAP Directory Server.

Host and server names and types.

Directory locations.

Installation information. For example, in Unix environments the UID and GID the server is run as.

The configdb file is located as follows:

Windows NT environments: Messaging Server looks for the local configdb file in the directory specified in the registry. By default, that directory is server-root\msg-instance\config.

Unix environments: Messaging Server looks for the local configdb file in the directory specified by the CONFIGROOT environment variable.

Usage Requirements

Most of the command-line utilities must be run locally on the messaging server. See the description of each utility for exceptions and command-specific login requirements.

Unix Login Requirements

In Unix environments, command-line utilities can only be run as root or as the login ID originally specified at the time of installation. By default, that is the mailsrv login ID. In other words, you have to log in as mailsrv to run these utilities. When running commands as root in some Unix environments, you must precede the command with ./ to specify the path. For example, ./mboxutil.

Windows NT Login Requirements

In Windows NT environments, the default is that command-line utilities are run from the same account that is used to run services. By default, that is the Administrator account. Therefore, you must have administrator privileges to run most of the command-line utilities.

Messaging Server Utilities--Descriptions

This section describes what the main Netscape Messaging Server command-line utilities do, defines their syntax, and gives examples of how they are used. The utilities are listed in alphabetical order.

configutil

The configutil utility enables you to list and change Messaging Server configuration options.

Most Messaging Server configuration options and values are stored in the LDAP database on Directory Server with the remaining options and values stored locally on Messaging Server in a file named configdb (for details, see Location of Configuration Data).

Note: If the administrator has defined any language-specific options (such as messages), you must use the language option at the end of the command in order to list or change them. Commands entered without a language option are only applied to attributes that do not have a specified language parameter.

configutil Syntax

configutil [-f configdbfile] [command-options] [;language]
configutil -i < inputfile

Requirements: Must be run locally on the Messaging server.
Location: server-root/bin/msg/admin/bin

You can use configutil to perform four tasks:

Display particular configuration options using -o option.

Add ;lang-xx after the option to list options with a specified language parameter. For example, ;lang-jp to list options specified for the Japanese language.

List configuration option values using the -e, -l, or -p prefix options.

Use -e to include configuration options with empty values in the list.

Use -l to just list local configuration options from the server's local configuration file.

Use -p prefix to just list those configuration options whose names begin with the letters specified in prefix.

Set configuration options using the -o option and -v value options.

Include the -l option with -o option and -v value to store the new value in the server's local configuration file.

To read the actual value from stdin, specify a dash (-) as the value on the command line.

Add ;lang-xx after the option to set options for a specified language parameter. For example, ;lang-jp to set options specified for the Japanese language.

Import configuration option values from stdin using the -i option.

Include the -e option with the -i option to import configuration options even if the value of the configuration option is empty.

Include the -l option with the -i option to import all configuration options to the server's local configuration file.

Table A.4 configutil options


Option	Description
-e	Lists configuration options that do not have values specified. May be used with the -l, -p, and -i options.
-f configdbfile	Enables you to specify a local configuration file other than the default. (This option uses information stored in the CONFIGROOT environment variable by default.)
-i < inputfile	Imports configurations from a file. Data in the file to be entered in option\|value format with no spaces on either side of the pipe. If you use -e with -i, and specify an option without a value, any existing value for that option is deleted. (If you do not use -e, when you specify an option without a value, no change is made to any existing value for that option.) Note that a Unix command line like cat inputfile \| configutil -i is not valid syntax.
-l option	Lists configuration options stored in the local server configuration file. When used in conjunction with the -v option, specifies that a configuration option value be stored in the local server configuration file.
-o option	Specifies the name of the configuration option that you wish to view or modify. May be used with the -l and -i options. Configuration option names starting with the word local are stored in the local server configuration file.
-p prefix	Lists configuration options with the specified prefix.
-v value	Specifies a value for a configuration option. To be used with -o option. If the -l option is also specified or the configuration option name specified with the -o option begins with local, the option value is automatically stored in the local server configuration file rather than the Directory Server.

If you specify no command-line options, all configuration options are listed.

Using the getconf and setconf Scripts

You can use the getconf and setconf scripts to more easily perform simple configutil tasks. These scripts use the following syntax to call configutil to perform these tasks:

To display the entire configuration database:

getconf

To display the value of a specified option:

getconf option

To set a specified option to a specified value:

setconf option value

To clear a specified option's value (that is, reset the option so that it has no value):

setconf option ""

For example, to set the value of the service.smtp.port configuration option to 25:

setconf service.smtp.port 25

To use setconf to set an SMTP banner with the text: "Welcome to Airius"

setconf service.smtp.banner "Welcome to Airius"

To use setconf to clear an SMTP banner:

setconf service.smtp.banner ""

You cannot use prefix pattern matching or language-specific values with these scripts.

Examples of Ways to Use configutil

To list all configuration options and their values in the both the Directory Server LDAP database and local server configuration file:

configutil

To import configurations from an input file named config.cfg:

configutil -i < config.cfg

To list all configuration options with the prefix service.imap:

configutil -p service.imap

To list all configuration options with the prefix service.imap, including those with empty values:

configutil -e -p service.imap

To display the value of the service.smtp.port configuration option:

configutil -o service.smtp.port

To set the value of the service.smtp.port configuration option to 25:

configutil -o service.smtp.port -v 25

To clear the value for the service.imap.banner configuration option:

configutil -o service.imap.banner -v ""

For information on using configutil to set alarm attributes, see Alarm Attributes.

Language Specific Options

To list or set options for a specific language, append ;lang-xx immediately after the option with no spaces, where xx is the two-letter language identifier. For example, to view the text of the Japanese version of the store.quotaexceededmsg message:

configutil -o "store.quotaexceededmsg;lang-jp"

counterutil

The counterutil utility displays and changes counters in a counter object. It can also be used to monitor a counter object every 5 seconds.

counterutil Syntax

counterutil -o counterobject [-r registryname]

Requirements: Must be run locally on the Messaging server.
Location: server-root/bin/msg/admin/bin

Table A.5 counterutil options


Option	Description
-o counterobject	Continuously display the contents of a particular counter object every 5 seconds.
-r registryname	Indicates the counter registry to use. If no registryname is specified with the -r registryname option, the default is server-root/msg-instance/counter/counter.

Examples of Ways to Use counterutil

To list all counter objects in a given server's counter registry:

counterutil

To display the content of counter object imapstat every 5 seconds:

counterutil -o imapstat -r server-root/msg-instance/counter/counter

deliver

The deliver utility delivers mail directly to the message store accessible by IMAP or POP mail clients.

If you are administering an integrated messaging environment, you can use this utility to deliver mail from another MTA, a sendmail MTA for example, to the Messaging Server message store.

deliver Syntax

deliver [-l] [-d] [-r address] [-f address] [-m mailbox] [-a authid] 
  [-q] [-F flag]...[userid]...

Requirements: Must be run locally on the Messaging server; the stored utility must also be running.
Location on Unix: server-root/bin/msg/store/bin
Location on NT: server-root/bin/msg/admin/bin

Table A.6 deliver options


Option	Description
-a authid	Specifies the authorization ID of the sender. Defaults to anonymous.
-d	This option is recognized by deliver in order to maintain compatibility with /bin/mail, but it is ignored by deliver.
-F flag	Sets the system flag or keyword flag on the delivered message.
-f address	Inserts a forwarding path header containing address.
-l	Accepts messages using the LMTP protocol (RFC 2033).
-m mailbox	Delivers mail to mailbox. If any user ids are specified, attempts to deliver mail to mailbox for each user id. If the access control on a mailbox does not grant the sender the "p" right or if the -m option is not specified, then this option delivers mail to the inbox for the user ID, regardless of the access control on the inbox. If no user ids are specified, this option attempts to deliver mail to mailbox. If the access control on a mailbox does not grant the sender the "p" right, the delivery fails.
-q	Overrides mailbox quotas. Delivers messages even when the receiving mailbox is over quota.
-r address	Inserts a Return-Path: header containing address.
userid	Deliver to inbox of the user specified by userid.

If you specify no options, mail is delivered to the inbox.

Examples of Ways to Use deliver

To deliver the contents of a file named message.list to Fred's Tasks mailbox:

deliver -m tasks fred < message.list

In this example, if the tasks mailbox does not grant "p" rights to the sender, the contents of message.list are delivered to the inbox of the user fred.

hashdir

The hashdir utility identifies the directory that contains the message store for a particular account. This utility reports the relative path to the message store, such as d1/a7/. The path is relative to the directory level just before the one based on the user ID. The utility sends the path information to the standard output.

hashdir Syntax

hashdir [-a] [-i] account_name

Requirements: Must be run locally on the Messaging server.
Location: server-root/bin/msg/admin/bin

Table A.7 hashdir options


Option	Description
-a	Appends the directory name to the output.
-i	Allows you to use the command in interactive mode.

imscripter

The imscripter utility connects to an IMAP server and executes a command or a sequence of commands.

imscripter Syntax

imscripter [-h] [-f script | [-c command] -f datafile]] [-c command] 
  [-s serverid | -p port | -u userid | -x passwd |-v verbosity]

Requirements: May be run remotely.
Location: server-root/bin/msg/admin/bin

Table A.8 imscripter options


Option	Description
-c command	Executes command, which can be one of the following: create mailbox delete mailbox rename oldmailbox newmailbox [partition] getacl mailbox setacl mailbox userid rights deleteacl mailbox userid If one or more of the above variables are included, the option executes the given command with that input. For example, create lincoln creates a mailbox for the user lincoln. If the -f file option is used, the option executes the command on each variable listed in the file.
-f file	The file may contain one or more commands, or a list of mailboxes on which commands are to be executed.
-h	Displays help for this command.
-p port	Connects to the given port. The default is 143.
-s server	Connects to the given server. The default is localhost. The server can either a host name or an IP address.
-u userid	Connects as userid.
-v verbosity	String containing options for printing various information. The options are as follows. The default is EPBibo (EBb if -f is specified). E - Show errors I - Show informational messages P - Show prompts C - Show input commands c - Show protocol commands B - Show BAD or NO untagged responses O - Show other untagged responses b - Show BAD or NO completion results o - Show OK completion results A - Show all of the above The letters designating options can be entered in any order.
-x passwd	Uses this password.

imscripter File Formats

Data files used with the -f option have to be formatted as a list of mailboxes with fully qualified paths, one mailbox per line. For example:

shared folders/paco/INBOX
shared folders/desmond/INBOX
shared folders/percival/INBOX

Scripts used with the -f option have to be in the following format:

command options

For example, an imscripter script file that adds the mailboxes contained in a file named add.list, and deletes mailboxes contained in a file named delete.list, looks like this:

create -f add.list
delete -f delete.list

Suppose the example file shown above is named dothis.script. To run it showing only errors, input commands, BAD and NO untagged and completion responses, enter:

imscripter -v ECBb -f dothis.script

Examples of Ways to Use imscripter

To run imscripter in interactive mode:

imscripter [options]

In interactive mode, each command is entered one line at a time at the imscripter prompt. The command is then executed and responses displayed.

To execute the commands specified in a script file:

imscripter [options] -f script

To execute a specific command on mailbox:

imscripter [options] [-l] -c command mailbox

To execute a specific command for each line of data in a data file:

imscripter [options] -c command -f datafile

To execute commands from the specified script file:

imscripter -s username.airius.com -f script

mailq

The mailq utility checks and reports on the queue of messages awaiting delivery.

mailq Syntax

mailq [-v]

Requirements: Must be locally run on the server.
Location on Unix: /bin/mailq
Location on NT: server-root/bin/msg/admin/bin

Table A.9 mailq options


Option	Description
-v	Provides more verbose information about the queue.

mailq Examples

To check the mail queue, type mailq at a command prompt. If there are no queued messages, that fact will be reported:

% mailq
Mail queue is empty.

If there are queued messages, each host that has queued messages waiting to be delivered will be listed, along with the number of pending deliveries. For example, output might look like this:

% mailq
Queued Messages Destination Host
--------------- ----------------
2 math.marsu.edu
3 universal-robots.com

In the example above, five messages are waiting for delivery. Delivering all of them should require two connections to other machines because the messaging server attempts to deliver all queued mail for a host before disconnecting.

For information how to manually force immediate delivery of messages in the mail queue, see processq.

mboxutil

The mboxutil utility lists, creates, deletes, renames, or moves mailboxes (folders).

mboxutil Syntax

mboxutil [-c mailbox] [-d mailbox] [-r oldname newname [partition]]
  [-l] [-p pattern] [-x] [-k] [-u]

Requirements: Must be run locally on the Messaging server; the stored utility must also be running.
Location: server-root/bin/msg/admin/bin

Mailbox Naming Conventions. You must specify mailbox names in the following format: user/userid/mailbox, where userid it the user that owns the mailbox and mailbox is the name of the mailbox. For example, the following command creates the mailbox named INBOX for the user whose user ID is crowe. INBOX is the default mailbox for mail delivered to the user crowe.

mboxutil -c user/crowe/INBOX

Important: The name INBOX is reserved for each user's default mailbox. INBOX is the only folder name that is case-insensitive. All other folder names are case-sensitive.

Table A.10 mboxutil options


Option	Description
-c mailbox	Creates the specified mailbox.
-d mailbox	Deletes the specified mailbox.
-k mailbox cmd	Locks the specified mailbox at the folder level; runs the specified command; after command completes, unlocks the mailbox. When a mailbox is locked the owner can view the messages it contains, but no new messages can be added and no existing messages can be deleted or moved. You should use the -k option before performing backups, for example.
-l	Lists all of the mailboxes on a server.
-p pattern	When used in conjunction with the -l option, lists only those mailboxes with names that match pattern. You can use IMAP wildcards.
-r oldname newname [partition]	Renames the mailbox from oldname to newname. To move a folder from one partition to another, specify the new partition with the partition option. Note that you cannot rename a user's INBOX. Nor can you use mboxutil -r to move mail stored under one user ID to another user ID.
-u	Lists user information such as current size of mail store, quota (if one has been set), and percentage of quota currently in use.
-x	When used in conjunction with the -l option, shows the path and access control for a mailbox.

Examples of Ways to Use mboxutil

To list all mailboxes for all users:

mboxutil -l

To list all mailboxes and also include path and acl information:

mboxutil -l -x

To create the default mailbox named INBOX for the user daphne:

mboxutil -c user/daphne/INBOX

To delete a mail folder named projx for the user delilah:

mboxutil -d user/delilah/projx

To delete the default mailbox named INBOX and all mail folders for the user druscilla:

mboxutil -d user/druscilla/INBOX

To rename Desdemona's mail folder from memos to memos-april:

mboxutil -r user/desdemona/memos user/desdemona/memos-april

To lock a mail folder named legal for the user dulcinea:

mboxutil -k user/dulcinea/legal cmd

where cmd is the command you wish to run on the locked mail folder.

To move the mail account for the user dimitria to a new partition:

mboxutil -r user/dimitria/INBOX user/dimitria/INBOX partition

where partition specifies the name of the new partition.

To move the mail folder named personal for the user dimitria to a new partition:

mboxutil -r user/dimitria/personal user/dimitria/personal partition

To list usage statistics:

mboxutil -u

quota use %use user
10240 297 29% daphne
no quota 168 delilah
no quota 0 druscilla

Quotas and usage figures are reported in kilobytes.

MoveUser

The MoveUser utility moves a user's account from one messaging server to another. When user accounts are moved from one messaging server to another, it's also necessary to move the user's mailboxes and the messages they contain from one server to the other. In addition to moving mailboxes from one server to another, MoveUser updates entries in the Directory Server to reflect the user's new mailhost name and message store path.

MoveUser Syntax

MoveUser -s srcmailhost[:port] -x proxyuser -p password
  [-u uid | -u uid -U newuid] [-l ldapURL -D bindDN -w password] 
  -d destmailhost[:port]   [options]

Requirements: May be run remotely.
Location: server-root/bin/msg/admin/bin

Table A.11 MoveUser options


Option	Description
-a destproxyuser	ProxyAuth user for destination messaging server.
-A	Do not add an alternate email address to the LDAP entry.
-d destmailhost	Destination messaging server. By default, MoveUser assumes IMAP port 143. To specify a different port, add a semi-colon and the port number after destmailhost. For example, to specify port 150 for myhost, you would enter -d myhost:150.
-D binddn	Binding dn to the given ldapURL.
-F	Delete messages in source messaging server after successful move of mailbox. (If not specified, messages will be left in source messaging server.)
-h	Display help for this command.
-l ldapURL	URL to establish a connection with the Directory Server: ldap://hostname:port/base_dn?attributes?scope?filter For more information about specifying an LDAP URL, see your Directory Server documentation. Cannot be used with the -u option.
-L	Add a license for Messaging Server if not already set.
-m destmaildrop	Message store path for destination messaging server. (If not specified, the default is used.)
-n msgcount	Number of messages to be moved at once.
-o srcmaildrop	Message store path for source messaging server. (If not specified, the default is used.)
-p srcproxypasswd	ProxyAuth password for source messaging server.
-s srcmailhost	Source messaging server. By default, MoveUser assumes IMAP port 143. To specify a different port, add a semi-colon and the port number after srcmailhost. For example, to specify port 150 for myhost, you would enter -s myhost:150.
-S	Do not set new message store path for each user.
-u uid	User ID for the user mailbox that is to be moved. Cannot be used with -l option.
-U newuid	New (renamed) user ID that the mailbox is to be moved to. Must be used with -u uid, where -u uid, identifies the old user name that is to be discontinued. Both the old and the new user ID must currently exist on both the source and the destination mailhost. After migration you are free to manually remove the original user ID from LDAP if you wish to do so.
-v destproxypwd	ProxyAuth password for destination messaging server.
-w bindpasswd	Binding password for the binddn given in the -D option.
-x srcproxyuser	ProxyAuth user for source messaging server.

ProxyAuth User

The ProxyAuth user is the user given the privilege to run the MoveUser command. In older Messaging Server 3.x environments the user ID of the Proxyauth user was specified in the file: /etc/netscape.mail.conf. In Messaging Server 4.x environments, any valid Message Store Administrator can be used to run the MoveUser command as the ProxyAuth user. The list of Message Store Administrators can be viewed and edited from the Netscape Console. For more information, see Specifying Administrator Access to the Store.

Examples of Ways to Use MoveUser

To move all users from host1 to host2, based on account information in the Directory Server airius.com:

MoveUser -l \
  "ldap://airius.com:389/o=Airius.com???(mailhost=host1.domain.com)" \
  -D "cn=Directory Manager" -w password -s host1 -x admin -p password \
  -d host2 -a admin -v password

To move one user from host1 which uses port 150 to host2, based on account information in the Directory Server airius.com:

MoveUser -l \
  "ldap://airius.com:389/o=Airius.com???(uid=userid)" \
  -D "cn=Directory Manager" -w password -s host1:150 -x admin \
  -p password -d host2 -a admin -v password

To move a group of users whose uid starts with letter `s' from host1 to host2, based on account information in the Directory Server server1.airius.com:

MoveUser -l \
  "ldap://server1.airius.com:389/o=Airius.com???(uid=s*)" \
  -D "cn=Directory Manager" -w password -s host1 -x admin \
  -p password -d host2 -a admin -v password

To move a user's mailboxes from host1 to host2 when the user ID of admin is specified in the command line:

MoveUser -u uid \
-s host1 -x admin -p password \
-d host2 -a admin -v password

To move a user named aldonza from host1 to a new user ID named dulcinea on host2:

MoveUser -u aldonza -U dulcinea \
-s host1 -x admin -p password \
-d host2 -a admin -v password

NscpMsg

The NscpMsg utility starts, stops, and refreshes the Messaging Server services. This utility is available in Unix environments only.

NscpMsg Syntax

/NscpMsg start   [ imap | pop | http | smtp | store | snmpagt ]
/NscpMsg stop    [ imap | pop | http | smtp | store | snmpagt ]
/NscpMsg refresh [ imap | pop | http | smtp | store | snmpagt ]
/NscpMsg list    [ imap | pop | http | smtp | store | snmpagt ]

Requirements: Must be run as root locally on the Messaging server.
Location: /etc
server-root/bin/msg/admin/bin

The NscpMsg utility sets the CONFIGROOT and LD_LIBRARY_PATH environment variables for the commands it runs.

Table A.12 NscpMsg options


Option	Description
refresh	Refresh messaging server processes.
start	Starts all messaging server processes (stored, smtpd, popd, imapd, httpd), or optionally, one specified service.
stop	Stops all messaging server processes (stored, smtpd, popd, imapd, httpd), or optionally, one specified service.
list	Lists all messaging server processes.

processq

The processq utility immediately delivers messages in the deferred queue.

processq Syntax

processq [[-R]hostname]

Requirements: Must be locally run on the server.
Location on Unix: /usr/lib
Location on NT: server-root/bin/msg/admin/bin

Table A.13 processq options


Option	Description
hostname	Deliver mail addressed to hostname. The hostname can be the full name of the host as reported by mailq, or any pattern contained in the name. If the pattern matches more than one hostname, each match will have its queue processed.
-R	Specify a specific domain.

The deferred queue is automatically processed at regular intervals, so you normally never need to deliver the queue manually with the processq utility. You can also manage the queue by using the Netscape Console. For more information, see Message Queue Concepts.

processq Examples

To deliver all messages in the deferred queue:

/usr/lib/processq

To deliver all queued mail addressed to math.marsu.edu:

/usr/lib/processq -Rmath.marsu.edu

To deliver all queued mail addressed to all hosts in the domain marsu.edu:

/usr/lib/processq `*.marsu.edu'

qconvert

The qconvert utility converts the Netscape Messaging Server 3.x message queue to the Netscape Messaging Server 4.x format.

Examples of Ways to Use qconvert

qconvert [-s sourceq -d targetq] [-l] [-r] [-h] [-f configdbfile]

Requirements: Must be run locally on the Messaging server.
Location: server-root/bin/msg/admin/bin

Table A.14 qconvert options


Option	Description
-d targetq	Specifies the path name of the new message queue.
-h	Displays help for this command.
-l	Writes the results to the screen. If you do not specify this option, qconvert writes results to the default log file in the log/default directory.
-r	Removes messages after conversion.
-s sourceq	Specifies the path name of the old message queue.
-f configdbfile	Specifies the path name of the configuration database.

If you do not specify the location of the 3.x message queue or the 4.x message queue, the qconvert utility reads the 3.x and 4.x configuration files to locate the message queue directories. Consequently, if you do not specify the message queue locations, the following configuration information must be available to the qconvert utility.

For Messaging Server 3.x, configuration information is determined as shown in Table A.15:

Table A.15 Messaging Server 3.x configuration information


Unix	Windows NT
MASTERCONFIG environment variable	Registry key in HKEY_LOCAL_MACHINE: SOFTWARE\\Netscape\MessagingServer\\3.0
/etc/netscape.mail.conf

For Messaging Server 4.x, configuration information is determined as shown in Table A.16 :

Table A.16 Messaging Server 4.x configuration information


Unix	Windows NT
CONFIGROOT environment variable	Registry key in HKEY_LOCAL_MACHINE: SOFTWARE\\Netscape\MessagingServer\\4.0
/etc/nsserver.cfg

The qconvert utility reads the 3.x directories in the following order:
sourceq/control, sourceq/deferred, sourceq/messages. These directories are subdirectories of the post office directory that was specified at installation time.

The qconvert utility reads and converts the 3.x directories as follows:

The utility reads the 3.x control files and rewrites them into the 4.x envelope log file located in targetq/control/env-date-1.

The utility reads the 3.x deferred directory and creates an envelope file for every subdirectory in the 4.x deferred directory.

The utility merges the 3.x message header file (-Header) and message body file (-Body) into one 4.x file located in targetq/control/msgname.

The utility automatically converts 3.x access rights to 4.x access rights so that users have access to the appropriate files.

quota

The quota utility reports mailbox quota usage. This utility generates a report listing quotas, giving their limits and usage.

quota Syntax

quota [user/user-id...]

Requirements: Must be run locally on the Messaging server; the stored utility must also be running.
Location: server-root/bin/msg/admin/bin

Table A.17 quota options


Option	Description
user/user-id	The quota listing is limited to quota roots with names that start with one of the given user IDs.

Netscape Messaging Server supports quotas at the root (inbox) level. Quotas on subdirectories are not supported.

readership

The readership utility reports on how many users other than the mailbox owner have read messages in a shared IMAP folder.

An owner of a IMAP folder may grant permission for others to read mail in the folder. A folder that others are allowed to access is called a shared folder. Administrators can use the readership utility to see how many users other than the owner are accessing a shared folder.

This utility scans all mailboxes.

readership Syntax

readership [-d days] [-p months]

Requirements: Must be run locally on the Messaging server; the stored utility must also be running.
Location: server-root/bin/msg/admin/bin

Table A.18 readership options


Option	Description
-d days	Counts as a reader any identity that has selected the shared IMAP folder within the indicated number of days. The default is 30.
-p months	Does not count users who have not selected the shared IMAP folder within the indicated number of months. The default is infinity and removes (prunes) the seen flag data for those users. This option also removes the "seen" flag data for those users from the store.

This utility produces one line of output per shared folder, reporting the number of readers followed by a space and the name of the mailbox.

Each reader is a distinct authentication identity that has selected the shared folder within the past specified number of days. Users are not counted as reading their own personal mailboxes. Personal mailboxes are not reported unless there is at least one reader other than the folder's owner.

reconstruct

The reconstruct utility rebuilds one or more mailboxes, or the master mailbox file, and repairs any inconsistencies. You can use this utility to recover from almost any form of data corruption in the mail store. Note that low-level database repair, such as completing transactions and rolling back incomplete transactions is performed with stored -d.

reconstruct Syntax

reconstruct [-p partition] [-r