Chapter 1   Messaging Server Command-line Utilities


iPlanet Messaging Server provides a set of command-line utilities in addition to its graphical user interface. This chapter describes utilities for messaging server starting, stopping, administration, message access, and message store.

For descriptions of the command-line utilities for the MTA, see Chapter 2 "Message Transfer Agent Command-line Utilities." For descriptions of the iPlanet Delegated Administrator for Messaging command-line utilities, see Chapter 3 "Delegated Administrator Command-line Utilities."

The commands described in this chapter are listed in Table 1-1.

Table 1-1    Messaging Server Commands 

Command	Description
configutil	Enables you to list and change Messaging Server configuration parameters.
counterutil	Displays all counters in a counter object. Monitors a counter object.
deliver	Delivers mail directly to the message store accessible by IMAP or POP mail clients.
hashdir	Identifies the directory that contains the message store for a particular account.
iminitquota	Reinitializes the quota limit from the LDAP directory and recalculates the disk space being used.
imsasm	Handles the saving and recovering of user mailboxes.
imsbackup	Backs up stored messages.
imsexport	Exports iPlanet Messaging Server mailboxes into UNIX /var/mail format folders.
imsimport	Migrates UINX /var/mail format folders into an iPlanet Messaging Server message store.
imsrestore	Restores messages from the backup device into the message store.
imscripter	The IMAP server protocol scripting tool. Executes a command or sequence of commands.
mboxutil	Lists, creates, deletes, renames, or moves mailboxes (folders).
mkbackupdir	Creates and synchronizes the backup directory with the information in the message store.
MoveUser	Moves a user's account from one messaging server to another.
quotacheck	Calculates the total mailbox size for each user in the message store and compares the size with their assigned quota.
readership	Reports on how many users other than the mailbox owner have read messages in a shared IMAP folder.
reconstruct	Rebuilds one or more mailboxes, or the master mailbox file, and repairs any inconsistencies.
start-msg	Starts the messaging server processes.
stop-msg	Stops the messaging server processes.
stored	Performs cleanup and expiration operations.

Command Descriptions

---

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

configutil

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

For a list of all configuration parameters, see Chapter 4 "Messaging Server Configuration."

Most iPlanet Messaging Server configuration parameters and values are stored in the LDAP database on Directory Server with the remaining parameters and values stored locally in the msg.conf and local.conf files. The startup parameters are stored in the msg.conf file and are set during installation. The local.conf files should not be edited manually. Use configutil to edit the parameters stored in those files.

---

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.

---

Requirements: Must be run locally on the Messaging server.

Location: server-root/bin/msg-instance/configutil

You can use configutil to perform four tasks:

• Display particular configuration parameters using -o option.
  • Add ;lang-xx after the option to list parameters with a specified language parameter. For example, ;lang-jp to list options specified for the Japanese language.

• List configuration parameter values using the -l or -p prefix options.
  • Use -l to just list local configuration parameters from the server's local configuration file.

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

• Set configuration parameters 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 parameter values from stdin using the -i option.
  • Include the -l option with the -i option to import all configuration parameters to the server's local configuration file.

Syntax

configutil [-f configdbfile] [-o option [;language] [-v value]]

configutil [-f configdbfile] [-p prefix][;language]

configutil [-f configdbfile] -l[-o option [;language] [-v value]]

configutil -i < inputfile

Options

The options for this command are:

Option	Description
-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. Note that a UNIX command line like cat inputfile | configutil -i is not valid syntax.
-l	Lists configuration parameters stored in the local server configuration file. When used in conjunction with the -v option, specifies that a configuration parameter value be stored in the local server configuration file.
-o option	Specifies the name of the configuration parameter that you wish to view or modify. May be used with the -l and -i options. Configuration parameter names starting with the word local are stored in the local server configuration file.
-p prefix	Lists configuration parameters with the specified prefix.
-v value	Specifies a value for a configuration parameter. To be used with -o option. If the -l option is also specified or the configuration parameter 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 parameters are listed.

Examples

To list all configuration parameter 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 parameters with the prefix service.imap:

configutil -p service.imap

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

configutil -o service.smtp.port

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

configutil -o service.smtp.port -v 25

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

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

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.

Requirements: Must be run locally on the Messaging server.

Location: server-root/bin/msg/admin/bin

Syntax

counterutil -o counterobject [-i interval] [-l] [-n numiterations]   [-r registryname]

Options

The options for this command are:

Option	Description
-i interval	Specifies, in seconds, the interval between reports. The default is 5.
-l	Lists the available counters in the registry specified by the -r option.
-n numiterations	Specifies the number of iterations. The default is infinity.
-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

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

counter

To display the content of a 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.

Requirements: Must be run locally on the Messaging Server; the stored utility must also be running. Make sure that the environment variable CONFIGROOT is set to server-root/msg-instance/config.

Location on UNIX: server-root/bin/msg/store/bin

Syntax

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

Options

The options for this command are:

Option	Description
-a authid	Specifies the authorization ID of the sender. Defaults to anonymous.
-c	Automatically creates the mailbox if it doesn't exist in the message store.
-d	This option is recognized by deliver in order to maintain compatibility with /bin/mail, but it is ignored by deliver.
-g 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 the user specified by userid.

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

Examples

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

deliver -m tasks fred < message.list

In the above 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 command identifies the directory that contains the message store for a particular account. This utility reports the relative path to the message store. The path is relative to the directory level just before the one based on the user ID. hashdir sends the path information to standard output.

Requirements: Must be run locally on the messaging server. Make sure that the environment variable CONFIGROOT is set to server-root/msg-instance/config.

Syntax

hashdir [-a] [-i] account_name

Options

The options for this command are:

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

Examples

hashdir user1

iminitquota

The iminitquota utility reinitializes the quota limit from the LDAP directory and recalculates the total amount of disk space that is being used by the users. It updates the message store quota.db database under the mboxlist directory in the message store. The iminitquota utility should be run after the reconstruct -q utility is run.

Syntax

iminitquota -a | -u userid

Options

The options for this command are:

Option	Description
-a	Initializes and updates the quota files for every message store user.
-u userid	Reinitializes and updates the quota-related information for the specified user. The userid parameter specifies the message store id of a user, not the login id of the user.

You must specify either the -a or -u option with the iminitquota command.

imsasm

The imsasm utility is an external ASM (Application Specific Module) that handles the saving and recovering of user mailboxes. imsasm invokes the imsbackup and imsrestore utilities to create and interpret a data stream.

During a save operation imsasm creates a save record for each mailbox or folder in its argument list. The data associated with each file or directory is generated by running the imsbackup or imsrestore command on the user's mailbox.

Syntax

imsasm [standard_asm_arguments]

Options

The options used in the imsasm utility are also known as standard-asm-arguments, which are Legato NetWorker® backup standards.

Either -s (saving), -r (recovering), or -c (comparing) must be specified and must precede any other options. When saving, at least one path argument must be specified. path may be either a directory or filename.

The following options are valid for all modes:

Option	Description
-n	Performs a dry run. When saving, walk the file system but don't attempt to open files and produce the save stream. When recovering or comparing, consume the input save stream and do basic sanity checks, but do not actually create any directories or files when recovering or do the work of comparing the actual file data.
-v	Turns on verbose mode. The current ASM, its arguments, and the file it is processing are displayed. When a filtering ASM operating in filtering mode (that is, processing another ASM's save stream) modifies the stream, its name, arguments, and the current file are displayed within square brackets.

When saving (-s), the following options may also be used:

Option	Description
-b	Produces a byte count. This option is like the -n option, but byte count mode will estimate the amount of data that would be produced instead of actually reading file data so it is faster but less accurate than the -n option. Byte count mode produces three numbers: the number of records, i.e., files and directories; the number of bytes of header information; and the approximate number of bytes of file data. Byte count mode does not produce a save stream so its output cannot be used as input to another asm in recover mode.
-o	Produces an "old style" save stream that can be handled by older NetWorker servers.
-e	Do not generate the final "end of save stream" Boolean. This flag should only be used when an ASM invokes an external ASM and as an optimization chooses not to consume the generated save stream itself.
-i	Ignores all save directives from .nsr directive files found in the directory tree.
-f proto	Specifies the location of a .nsr directive file to interpret before processing any files. Within the directive file specified by proto, path directives must resolve to files within the directory tree being processed, otherwise their subsequent directives will be ignored.
-p ppath	Prepends this string to each file's name as it is output. This argument is used internally when one ASM executes another external ASM. ppath must be a properly formatted path which is either the current working directory or a trailing component of the current working directory.
-t date	The date after which files must have been modified before they will be saved.
-x	Crosses file system boundaries. Normally, file system boundaries are not crossed during walking.

When recovering (-r), the following options may also be used:

Option	Description
-i response	Specifies the initial default overwrite response. Only one letter may be used. When the name of the file being recovered conflicts with an existing file, the user is prompted for overwrite permission. The default response, selected by pressing Return, is displayed within square brackets. Unless otherwise specified with the -i option, n is the initial default overwrite response. Each time a response other than the default is selected, the new response becomes the default. When either N, R, or Y is specified, no prompting is done (except when auto-renaming files that already end with the rename suffix) and each subsequent conflict is resolved as if the corresponding lower case letter had been selected. The valid overwrite responses and their meanings are: n—Do not recover the current file. N—Do not recover any files with conflicting names. y—Overwrite the existing file with the recovered file. Y—Overwrite files with conflicting names. r—Rename the conflicting file. A dot "." and a suffix are appended to the recovered file's name. If a conflict still exists, the user will be prompted again. R—Automatically renames conflicting files by appending a dog "." and a suffix. If a conflicting file name already ends in a .suffix, the user will be prompted to avoid potential auto rename looping conditions.
-m src=dst	Maps the file names that will be created. Any files that start exactly with src will be mapped to have the path of dst replacing the leading src component of the path name. This option is useful if you wish to perform relocation of the recovered files that were saved using absolute path names into an alternate directory.
-z suffix	Specifies the suffix to append when renaming conflicting files. The default suffix is R.
path	Restricts the files being recovered. Only files with prefixes matching path will be recovered. This checking is performed before any potential name mapping is done with the -m option. When path is not specified, no checking is performed.

Examples

To use imsasm to save the mailbox INBOX for user joe, the system administrator creates a directory file backup_root/backup/DEFAULT/joe/.nsr with the following contents:

imsasm: INBOX

This causes the mailbox to be saved using imsasm. Executing the mkbackupdir utility will automatically create the .nsr file. See mkbackupdir.

imsbackup

The imsbackup utility is used to write selected contents of the message store to any serial device, including magnetic tape, a UNIX pipe, or a plain file. The backup or selected parts of the backup may later be recovered via the imsrestore utility. The imsbackup utility provides a basic backup facility similar to the UNIX tar command.

Location: server-root/bin/msg/store/bin

For more information about imsbackup and backing up the message store, see the section "Backing Up and Restoring the Message Store" in the iPlanet Messaging Server Administrator's Guide.

Syntax

imsbackup -f device|- [-a userid] [-b blocking_factor] [-d datetime] [-i]   [-l] [-m link_count] [-u file] [-v] [path]

Options

The options for this command are:

Option	Description
-a userid	Authenticates the specified user.
-b blocking_factor	Everything written to the backup device is performed by blocks of the size 512xblocking_factor. The default is 20.
-d datetime	Date from which messages are to be backed up, expressed in yyyymmdd[:hhmmss]; for example, -d 19990501:13100 would backup messages stored from May 1, 1999 at 1:10 pm to the present. The default is to backup all the messages regardless of their dates.
-f device|-	Specifies the file name or device to which the backup is written. If device is `-', backup data is written to stdout.
-i	Ignore links. Used for POP store.
-l	Used to autoload tape devices when end-of-tape is reached.
-m link_count	Specifies the minimum link count for hashing.
-u file	Specifies the object name file to backup. This file contains object names (user, group, mailbox, or store instance). See path for the object names format. For example: To specify a user: /mystore/ALL/joe To specify a group: /mystore/groupA
-v	Executes the command in verbose mode.
path	Logical pathname of the backup object. You must specify the backup path in one of the following formats: To specify a mailbox: /msg_store/group/user/mailbox To specify a user: /msg_store/group/user To specify a group: /msg_store/group To specify a message store instance: /msg_store

Examples

The following example backs up joe to /dev/rmt/0:

imsbackup -f /dev/rmt/0 /mystore/ALL/joe

mystore maps to the default partition.

The following example backs up all users under groupA to backupfile:

imsbackup -f- /mystore/groupA > backupfile

The following example performs a full backup of the message store instance mystore:

imsbackup -f /dev/rmt/0 /mystore

imsexport

The imsexport utility exports iPlanet Messaging Server mailboxes into UNIX /var/mail format folders.

The imsexport utility extracts the messages in a message store folder and writes the messages to a UNIX file under the directory specified by the administrator. The file name is the same name as the IMAP folder name. For message store folders that contain both messages and sub-folders, imsexport creates a directory with the folder name and a file with the folder name plus a .msg extension. The folder.msg file contains the messages in the folder. The folder directory contains the sub-folders.

Syntax

imsexport -d dir -u user [-a user] [-c y|n] [-g] [-s mailbox] [-v mode]

Options

The options for this command are:

Option	Description
-a user	Specifies the user name for authentication.
-c y|n	Provides an answer to the question: "Do you want to continue?" Specify y for yes, and specify n for no.
-d dir	Specifies the destination directory name where the folders will be created and written. This is a required option.
-g	Specifies debugging mode.
-s mailbox	Specifies the source folder to export.
-u user	Specifies the message store id for a user. Note that this is not necessarily the login id of the user. This is a required option.
-v mode	Specifies verbose mode. The values for mode are 0, 1, and 2. 0 specifies no output. 1 specifies mailbox level output. 2 (default) specifies message level output.

Example

In the following example, imsexport extracts all email for user smith1. smith1 is a valid user account in the iPlanet Messaging Server message store. User smith1 has three folders on the store: INBOX (the normal default user folder), private, and private/mom. The destination directory will be /tmp/joes_mail.

% imsexport -u smith1 -d /tmp/joes_mail/

imexport then transfers each message store folder into a /var/mail conforming file. Thus you will get the following files:

• /tmp/joes_mail/INBOX

• /tmp/joes_mail/private

• /tmp/joes_mail/private.msg

• /tmp/joes_mail/private/mom

imsimport

The imsimport utility migrates UNIX /var/mail format folders into an iPlanet Messaging Server message store.

The imsimport utility extracts the messages stored in /var/mail mailboxes and appends them to the corresponding users' folder in the iPlanet Messaging Server message store. Files in the directory that are not in the standard UNIX mailbox format are skipped. If the corresponding users do not exist in the message store, imsimport creates them. When the user quota is exceeded, imsimport bypasses the message store quota enforcement, so the user does not receive an "over quota" message.

---

Note	imsimport does not use the IMAP server. Howerver, the stored utility must be running to maintain message store integrity. The LDAP server should be running if imsimport is expected to create new users.

---

Syntax

imsimport -u user -s file [-a user] [-c y|n] [-d mailbox] [-g] [-n]   [-v mode]

Options

The options for this command are:

Option	Description
-a user	Specifies the user name for authentication.
-c y|n	Provides an answer to the question: "Do you want to continue?" Specify y for yes, and specify n for no.
-d mailbox	Specifies the destination mailbox where the messages will be stored.
-g	Specifies debugging mode.
-n	Creates a new mailbox with a .date extension if the mailbox exists. The .date extension is in the following form: .mmddyy.HHMMSS The month is specified by mm. The day is specified by dd. The year is specified by yy. For example, 052097 specifies May 20 in the year 1997. The time of day is specified by HHMMSS. For example 110000 specifies 11:00am.
-s file	Specifies the UNIX folder's file name where the messages to be import exist. The file parameter must be a full path name. This is a required option.
-u user	Specifies the message store id for a user. Note that this is not necessarily the login id of the user. This is a required option.
-v mode	Specifies verbose mode. The values for mode are 0, 1, and 2. 0 specifies no output. 1 specifies mailbox level output. 2 (default) specifies message level output.

Examples

imsimport migrates the specified /var/mail/folder for the specified user to the iPlanet Messaging Server message store. If the destination folder is not specified, imsimport calls the destination folder by the same name as the source folder. In the following example, the command migrates the default /var/mail INBOX for the user smith, to the INBOX.

imsimport -u smith -s /var/mail/smith -d INBOX

Similarly, if you are trying to move a folder called test from /home/smith/folders/ to the iPlanet Messaging Server message store, use the following command:

imsimport -u smith -s /home/smith/folders/test -d test

If a destination folder called test already exists in the iPlanet Messaging Server message store, imsimport appends the messages to the existing folder in the mailbox.

imsrestore

The imsrestore utility restores messages from the backup device into the message store.

Location: server-root/bin/msg/store/bin

Syntax

imsrestore -f device|- [-a userid] [-b blocking_factor] [-c y | n]   [-h] [-i] [-m file] [-n] [-t] [-u file]   [-v 0|1|2] [path]

Options

The options for this command are:

Option	Description
-a userid	Authenticates the specified user.
-b blocking_factor	Indicates the blocking factor. Everything read on the device is performed by blocks of the size 512 x blocking_factor. The default is 20. Note: this number needs to be the same blocking factor that was used for the backup.
-c y | n	Automatically answers yes or no to the question "Do you want to continue?"
-f device|-	When -f- is specified, backup data from stdin is read. Otherwise, the backup data is read from the specified device or filename.
-h	Dumps the header.
-i	Ignores existing messages. Does not check for existing messages before restore. Note that if you specify the -i option, you may have duplicate messages after the restore, since the -i option supersedes your ability to check for duplicates.
-m file	This mapping file is used when renaming user ids. The format in the mapping file is oldname=newname with one set of names per line. For example: a=x b=y c=z where a, b, and c are old names and x, y, and z are new names. This option is only used to rename user IDs from an older version of iPlanet Messaging Server to a newer version of iPlanet Messaging Server. Use the -u option for restoring users from SIMS to iPlanet Messaging Server.
-n	Creates a new mailbox with a .date extension (if the mailbox exists). By default, messages are appended to the existing mailbox.
-t	Prints a table of contents, but restore is not performed.
-u file	Specifies the object name file to be used by the restore. For iPlanet Messaging Server backup data, see path for the object names format. For example: /mystore/ALL/joe /mystore/groupA For restoring SIMS data into an iPlanet Message Store, you can specify or rename users with -u file. To specify users, the file should have one name on each line. If you rename users, the format of file is oldname=newname with one set of names per line. For example: joe bonnie jackie=jackie1 where joe and bonnie are restored, and jackie is restored and renamed to jackie1.
-v [0|1|2]	Executes the command in verbose mode. 0 = no output 1= output at mailbox level 2= output at message level
path	Logical pathname of the backup object. You must specify the path in one of the following formats: To specify a mailbox: /msg_store/group/user/mailbox To specify a user: /msg_store/group/user To specify a group: /msg_store/group To specify a message store instance: /msg_store

Examples

The following example restores the messages from the file backupfile:

imsrestore -f backupfile

The following example restores the messages for user1 from the file backupfile:

imsrestore -f backupfile /mystore/ALL/user1

The following example lists the content of the file backupfile:

imsrestore -f backupfile -t

The following example renames users in the file mapfile:

imsrestore -m mapfile -f backupfile

where the mapfile format is oldname=newname:

userA=user1
userB=user2
userC=user3

imscripter

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

Requirements: May be run remotely.

Location: server-root/bin/msg/admin/bin

Syntax

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

Options

The options for this utility are:

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 be 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: 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. The default is EPBibo.
-x passwd	Uses this password.

mboxutil

The mboxutil command lists, creates, deletes, renames, or moves mailboxes (folders). mboxutil can also be used to report quota information.

You must specify mailbox names in the following format:

user/userid/mailbox

userid is the user that owns the mailbox and mailbox is the name of the mailbox.

Requirements: Must be run locally on the messaging server; the stored utility must also be running.

Location: server_root/bin/msg/admin/bin

Syntax

mboxutil [-a] [-c mailbox] [-d mailbox] [-f file] [-g group]   [-r oldname newname [partition]] [-l] [-p pattern] [-q domain] [-x]   [-k cmd mailbox] [-u [userid]]

Options

The options for this command are:

Option	Description
-a	Lists all user quota information.
-c mailbox	Creates the specified mailbox. A mailbox must exist before creating a secondary mailbox.
-d mailbox	Deletes the specified mailbox. There are some limitations with using the -d option to remove a user. Using the -d option to remove an active user (by removing the mailbox user/userid/INBOX) could result in a partially deleted mailbox. This occurs when either the user is connecting to the server or when the server is delivering mail to the user's mailbox. The recommended method to delete a user is to mark the user status as deleted in LDAP (using the imadmin user delete utility), and then use the imadmin user purge utility to purge the users that have been marked as deleted for a period longer than the specified number of days.
-f file	Creates, deletes, or locks the mailbox or mailboxes listed in the specified data file. The -f option can be used with the -c, -d or -k options. The data file contains a list of mailboxes on which the mboxutil command is executed. The following is an example of entries in a data file: user/daphne/INBOX user/daphne/projx user/daphne/mm
-g group	Lists quota information for the specified group.
-k cmd mailbox	Locks the specified mailbox at the folder level; runs the specified shell 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. If you create multibyte folders for different language locales, you should edit: server-root/bin/msg/bundles/encbylang.properties to associate the appropriate character set with the LANG environment variable.
-p pattern	When used in conjunction with the -l option, lists only those mailboxes with names that match pattern. You can use IMAP wildcards.
-q domain	Lists quota information for the specified domain.
-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.
-u [userid]	Lists user information such as current size or message store, quota (if one has been set), and percentage of quota currently in use.
-x	When used in conjunction with the -l option, displays the path and access control for a mailbox.

Examples

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 daphne diskquota size(K) %use msgquota msgs %use user 10240 297 no quota 953 29% daphne

mkbackupdir

The mkbackupdir utility creates and synchronizes the backup directory with the information in the message store. It is used in conjunction with Solstice Backup (Legato Networker). The backup directory is an image of the message store. It does not contain the actual data. mkbackupdir scans the message store's user directory, compares it with the backup directory, and updates the backup directory with the new user names and mailbox names under the message store's user directory.

The backup directory is created to contain the information necessary for Networker to backup the message store at different levels (server, group, user, and mailbox). Figure 1-1 displays the structure.

Figure 1-1    Backup directory hierarchy

Location: server_root/bin/msg/store/bin

The variables in the backup directory contents are:

Variable	Description
BACKUP_ROOT	Message store administrator root directory as specified in the ims.cnf file. The default directory is server_root/.
group	System administrator-defined directories containing user directories. Breaking your message store into groups of user directories allows you to do concurrent backups of groups of user mailboxes. To create groups automatically, specify your groups in the server_root/msg-instance/config/backup-groups.conf file. The format for specifying groups is: groupname= pattern groupname is the name of the directory under which the user and mailbox directories will be stored, and pattern is a folder name with IMAP wildcard characters specifying user directory names that will go under the groupname directory.
user	Name of the message store user.
folder	Name of the user mailbox directory.
mailbox	Name of the user mailbox.

The mkbackupdir utility creates:

• A default group directory (ALL) or the group directories defined in the backup-groups.conf configuration file. The following is a sample backup-groups.conf file:

  groupA=a* groupB=b* groupC=c* . . .

• A user directory under the backup directory for each new user in the message store.

• A 0 length mailbox file for each mailbox.

• A .nsr file for each subdirectory that contains user mailboxes.

The .nsr file is the NSR configuration file that informs the Networker to invoke imsasm. imsasm then creates and interprets the data stream.

Each user mailbox contains files of zero length. This includes the INBOX, which is located under the user directory.

---

Note	Make sure the backup directory is writable by the message store owner (mailsrv).

---

Syntax

mkbackupdir [-a userid] [-i | -f] [-g] [-v] -p directory

Options

The options for this command are:

Option	Description
-a userid	Authenticates the specified user.
-f	Backs up the folders only. By default, all mailboxes are backed up.
-g	Executes the command in debug mode.
-i	Backs up the inbox only. By default, all mailboxes are backed up.
-p directory	Specifies the directory for the backup image. This is a required option. Note: The Networker has a limitation of 64 characters for saveset name. If your default backup directory pathname is too long, you should use this option to specify another pathname.
-v	Executes the command in verbose mode.

Examples

To create the mybackupdir directory, enter the following:

mkbackupdir -p /mybackupdir

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

Requirements: May be run remotely.

Location: server-root/bin/msg/admin/bin

---

Note	If you expect the moveuser utility to alter the LDAP attributes, then you must run the following command to set the authentication cache timeout value to 0: configutil -o service.authcachettl -v 0

---

Syntax

MoveUser -s srcmailhost[:port] -x proxyuser -p password -d destmailhost[:port]   [-u uid | -u uid -U newuid| -l ldapURL -D binDN -w password   [-r DCroot -t defaultDomain]]

Options

The options for this command are:

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.
-r DCroot	DC root used with the -l option to move users under a hosted domain.
-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.
-t defaultDomain	Default domain used with the -l option to move users under a hosted domain.
-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.

Examples

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

MoveUser -l \ "ldap://siroe.com:389/o=siroe.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 siroe.com:

MoveUser -l \ "ldap://siroe.com:389/o=siroe.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.siroe.com:

MoveUser -l \ "ldap://server1.siroe.com:389/o=siroe.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

quotacheck

The quotacheck utility calculates the total mailbox size for each user in the message store. This utility can also compare mailbox size with a user's assigned quota. As an option, you can email a notification to users who have exceeded a set percentage of their assigned quota.

Requirements: Must be run as the message store owner. This utility depends on the iPlanet Messaging Server shared libraries. Set the LD_LIBRARY_PATH or SHLIB_PATH appropriately. These libraries are located in: server-root/bin/msg/lib.

Dependencies: The delivery agent's quota warning mechanism needs to be turned off in order for quotacheck to work, because the quotacheck and the delivery agent use the same element in the quota database to record last-warn time. To turn off the delivery agent's quota warning, remove the attribute value for nsmsgquotaexceededmsg;lang-en in the directory.

Location: server-root/bin/msg/admin/bin

Syntax

The following form of quotacheck should be used when you want to notify users if they have exceeded a set percentage of their assigned quota.

quotacheck [-e] [-d domain] [-r rulefile] [-t message template] [-D] -n

This following of quotacheck should be used when you want to report the usage to stdout.

quotacheck [-e] [-d domain][-r rulefile] [-t message template] [-i] [-v]   [-h] [-u user] [-D]

Options

The options for this command are:

Option	Description
-e	Allows extended reporting. Per folder usage is included in the report.
-d domain	Looks for users only in the specified domain.
-r rulefile	Specifies the set of rules to be used when you want to calculate quota usage. If -r is not specified, a default rulefile can be used. To setup a default rulefile, copy the "Sample Rulefile" to server-root/msg-instance/config. See "Rulefile Format".
-t message template	Notifies users when their mailbox quota is exceeded. The message template format is the following: %U% - user's mailbox id %Q% - percentage of the used mailbox quota %R% - quota usage details: assigned quota, total mailbox size, and percentage used. If the -e is specified, mailbox usage of the individual folders are also reported. %M% - current mailbox size %C% - quota attribute value If -t is not specified, a default message file will be mailed. To setup a default message file, copy the "Notification File" to server-root/msg-instance/config.
-n	Sends notification messages based on the rules defined in the rulefile. If you do not define any rules when you use this option, you will receive an error.
-i	Ignores the rulefile and any active rule defined in it. The quota status of all the users in the message store will be printed to stdout. This option can only be used when you want to report usage. If -i is not specified, the active rule with the least threshold is used to print a list of all of the users and their quota status to stdout.
-v	Prints the username, quota, total mailbox size and percentage of mailbox used by all of the users. When you are using quotacheck to report usage, it will default to this option if no other options are specified.
-u user	Obtains the quota status of the specified user id. Can be used with -e for extended reporting on the user. Can be used multiple times to specify multiple users. For example: quotacheck -u user1 -u user2 -u user3
-D	Debug mode; displays the execution steps to stdout.

Examples

To send a notification to all users in accordance to the default rulefile:

quotacheck -n

To send a notification to all users in accordance to a specified rulefile, myrulefile, and to a specified mail template file, mytemplate.file:

quotacheck -n -r myrulefile -t mytemplate.file

To list the usage of all users whose quota exceeds the least threshold in the rulefile:

quotacheck

To list the usage of all users and (will ignore the rulefile):

quotacheck -i

To list per folder usages for users user1 and user2 (will ignore the rulefile):

quotacheck -u user1 -u user2 -e

To only list the users in domain siroe.com:

quotacheck -d siroe.com -i

Rulefile Format

The rulefile format is organized into two sections: a general section and a rule name section. The general section contains attributes that are common across all rules. Attributes that are typically specified in the general section are the mailQuotaAttribute and the reportMethod. In the rule name section, you can write specific quota rules for notification intervals, trigger percentages, and so on. Attributes that are typically specified in the rule name section are notificationTriggerPercentage, enabled, notificationInterval, and messageFile. Note that the attributes and corresponding values are not case-sensitive. The following rulefile format is used:

[General]
mailQuotaAttribute = [value]
reportMethod = [value]

[rulename1]
attrname=[value]
attrname=[value]

[rulename2]
attrname=[value]
attrname=[value]

[rulename3]
attrname=[value]
attrname=[value

General Attribute	Required Attribute?	Default Value	Description
mailQuotaAttribute	No	Value in quotadb	Specifies the name of the custom mailquota attribute. If not specified, the value in quotadb is used.
reportMethod	No		Can customize the output of the quota report. The value of this attribute is specified as library-path:function, where library-path is the path of the shared library and function is the name of the report function. See "reportMethod Signature" to see the structure of the attribute.

Rule Attribute	Required Attribute?	Default Value	Description
notificationTriggerPercentage	Yes		Specifies the consumed quota percentage that will trigger notification. Value should be unique and an integer.
messageFile	No	server-root/ config/ imq.msgfile	Specifies the absolute path to the message file.
notificationInterval	Yes		Indicates the number of hours before a new notification is generated.
enabled	No	0 (FALSE)	Indicates if the particular rule is active. Applicable values are 0 for FALSE and 1 for TRUE.
notificationMethod	No		Can customize the overquota notification method to send to the user. The value of this attribute is specified as library-path:function, where library-path is the path of the shared library and function is the name of the report function. See "notificationMethod Signature" to see the structure of the attribute.

reportMethod Signature
The following signature can be used for the reportMethod():

int symbol(QuotaInfo* info, char** message, int* freeflag) info is a pointer to the following structure: typedef struct QuotaInfo {   const char* username; /* user name (uid or uid@domain) */   long quotakb; /* quota in kbytes */   long quotamsg; /* quota in number of messages */   ulong usagekb; /* total usage in kbytes */   ulong usagemsg; /* total usage in number of messages */   FolderUsage* folderlist; /* folder list (for -e) */   long num_folder; /* number of folders in the folderlist */   long trigger; /* not used */   const char* rule; /* not used */ } typedef struct FolderUsage {   const char*foldername;   ulong usagekb; /* folder usage in kbytes */ }

The address, message, points to the output message. The report function is expected to fill the value of *message and allocate memory for message when necessary. The freeflag variable indicates if the caller is responsible for freeing allocated memory for *message.

The return values are 0 for success and 1 for failure.

The quotacheck function will invoke the reportMethod to generate the report output. If the reportMethod returns 0 and *message is pointing to a valid memory address, message will be printed.

If the *freeflag is set to 1, the caller will free the memory address pointed to by message. If the -e option is specified, the quota usage for every folder will be stored in the folderlist, an array in FolderUsage; the num_folder variable is set to the number of folders in the folderlist.

notificationMethod Signature
The following signature can be used for the notificationMethod():

The notification function has the following prototype: int symbol(QuotaInfo* info, char** message, int* freeflag) info is a pointer to the following structure: typedef struct QuotaInfo {   const char* username; /* user name (uid or uid@domain) */   long quotakb; /* quota in kbytes */   long quotamsg; /* quota in number of messages */   ulong usagekb; /* total usage in kbytes */   ulong usagemsg; /* total usage in number of messages */   FolderUsage* folderlist; /* folder list (for -e) */   long num_folder; /* number of folders in the folderlist */   long trigger; /* the exceeded notificationTriggerPercentage */   const char* rule; /* rulename that triggered notification */ } typedef struct FolderUsage {   const char *foldername;   ulong usagekb; /* folder usage in kbytes */ }

The address, message, points to the notification message. The notification function is expected to fill in the value of this variable and allocate the memory for the message when necessary. The freeflag variable indicates if the caller is responsible for freeing the memory allocated for message.

The return values are 0 for success and 1 for failure.

If the notification function returns a 0, and *message is pointing to a valid address, the quotacheck utility will deliver the message to the user. If the *freeflag is set to 1, the caller will free the memory address pointed to by message after the message is sent.

If the -e option is specified, the quota usage for every folder will be stored in the folderlist variable, an array of FolderUsage structure; the num_folder variable is set to the number of folders in the folderlist.

---

Note	If the messageFile attribute is also specified, the attributed messageFile will be ignored.

---

Sample Rulefile
#
# Sample rulefile
#
[General]
mailQuotaAttribute=mailquota
reportMethod=/xx/yy/libzz.so:myReportMethod [for Solaris only ]
      /xx/yy/libzz.sl:myReportMethod [for HP-UX only]
      \xx\yyi ibzz.dll:myReportMethod [for Windows NT only]

[rule1]
notificationTriggerPercentage=60
enabled=1
notificationInterval=3
notificationMethod=/xx/yy/libzz.so:myNotifyMethod_60

[rule2]
notificationTriggerPercentage=80
enabled=1
notificationInterval=2
messageFile=/xx/yy/message.txt

[rule3]
notificationTriggerPercentage=90
enabled=1
notificationInterval=1
notificationMethod=/xx/yy/libzz.so:myNotifyMethod_90

#
# End
#

Threshold Notification Algorithm

1. Rule precedence is determined by increasing trigger percentages.

2. The highest applicable threshold is used to generate a notification. The time and the rule's threshold are recorded.

3. If users move into a higher threshold since their last quota notification, a new notification will be delivered based on the current set of applicable rules. This notice can be immediately delivered to any user whose space usage is steadily increasing.

4. If usage drops, the notification interval of the current rule (lower threshold) will be used to check the time elapsed since the last notice.

5. The stored time and threshold for the user will be reset to zero if the user's mailbox size falls below all of the defined thresholds.

Notification File

The utility depends on the message file to have at minimum a Subject Header. There should be at least one blank line separating the Subject from the body. The other requires headers are generated by the utility/ The notification file format is the following:

Subject: [Warning] quota reached for %U%

Hello %U%,
Your quota: %C%
Your current mailbox usage: %M%
Your mailbox is now %Q% full. The folders consuming the most space are: %R%.

Please clean up unwanted diskspace.

Thanks,
-Administrator

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

The utility scans all mailboxes.

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.

Requirements: Must be run locally on the messaging server; the stored utility must also be running.

Location: server-root/bin/msg/admin/bin

Syntax

readership [-d days] [-p months]

Options

The options for this command are:

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 the seen flag data for those users. This option also removes the "seen" flag data for those users from the store.

reconstruct

The reconstruct utility rebuilds one or more mailboxes, or the master mailbox file (the mailboxes database), and repairs any inconsistencies. You can use this utility to recover from almost any form of data corruption in the message store.

A mailbox consists of files under the user partition directory. The mailboxes database is the mboxlist database.

Requirements: Must be run locally on the messaging server; the stored utility must also be running.

Location: server-root/bin/msg/admin/bin

---

Note	Low-level database repair, such as completing transactions and rolling back incomplete transactions is performed with stored -d.

---

Syntax

reconstruct [-n | -f] [-p partition] -r [mailbox [mailbox...]]

reconstruct [-n | -f] [-p partition] mailbox [mailbox...]

reconstruct [-p partition] -m

reconstruct -q

reconstruct -o [-d filename]

Options

The options for this command are:

Option	Description
-f	Forces reconstruct to perform a fix on the mailbox or mailboxes.
-m	Repairs and performs a consistency check of the mailboxes database. This option examines every mailbox it finds in the spool area, adding or removing entries from the mailboxes database as appropriate. The utility prints a message to the standard output file whenever it adds or removes an entry from the database.
-n	Checks the message store only, without performing a fix on the mailbox or mailboxes. The -n option cannot be used by itself, unless a mailbox name is provided. When a mailbox name is not provided, the -n option must be used with the -r option; the -r option may be combined with the -p option. For example, any of the following commands are valid: reconstruct -n user/dulcinea/INBOX reconstruct -n -r reconstruct -n -r -p primary reconstruct -n -r user/dulcinea/
-o	Checks for orphaned accounts. This option searches for inboxes in the current messaging server host which do not have corresponding entries in LDAP. For example, the -o option finds inboxes of owners who have been deleted from LDAP or moved to a different server host. For each orphaned account it finds, reconstruct writes the following command to the standard output: mboxutil-d user/userid/INBOX
-o -d filename	If -d filename is specified with the -o option, reconstruct opens the specified file and writes the mboxutil -d commands into that file. The file may then be turned into a script file to delete the orphaned accounts.
-p partition	Specifies a partition name; do not use a full path name. If this option is not specified, reconstruct defaults to all partitions.
-q	Fixes any inconsistencies in the quota subsystem, such as mailboxes with the wrong quota root or quota roots with the wrong quota usage reported. The -q option can be run while other server processes are running.
-r [mailbox]	Repairs and performs a consistency check of the partition area of the specified mailbox or mailboxes. The -r option also repairs all sub-mailboxes within the specified mailbox. If you specify -r with no mailbox argument, the utility repairs the spool areas of all mailboxes within the user partition directory.

The mailbox argument indicates the mailbox to be repaired. You can specify one or more mailboxes. Mailboxes are specified with names in the format user/userid/sub-mailbox, where userid is the user that owns the mailbox. For example, the inbox of the user dulcinea is entered as: user/dulcinea/INBOX.

Examples

The following command performs a reconstruct on a specific mailbox:

reconstruct user/dulcinea/INBOX

The following checks the specified mailbox, without performing a reconstruct:

reconstruct -n user/dulcinea/INBOX

The following command checks all mailboxes in the message store:

reconstruct -n -r

start-msg

The start-msg utility starts all of the messaging server processes (smtp, imap, pop, store, http, ens), or optionally, one specified service.

Syntax

start-msg [smtp | imap | pop | store | http | ens]

Examples

The following command starts all the messaging server processes:

start-msg

The following command starts the imap process:

start-msg imap

stop-msg

The stop-msg utility stops all messaging server processes (smtp, imap, pop, store, http, ens), or optionally, one specified service.

Syntax

stop-msg [smtp | imap | pop | store | http | ens]

Examples

The following command stops all messaging server processes:

stop-msg

The following command stops the http service:

stop-msg http

stored

The stored utility performs the following functions:

• Background and daily messaging tasks

• Deadlock detection and rollback of deadlocked database transactions

• Cleanup of temporary files on startup

• Implementation of aging policies

• Periodic monitoring of server state, disk space, service response times, and so on

• Issuing of alarms if necessary

The stored utility automatically performs cleanup and expiration operations once a day at midnight. You can choose to run additional cleanup and expiration operations.

Requirements: Must be run locally on the Messaging Server.

Location: server-root/bin/msg/admin/bin

Syntax

To run stored from the command line to perform a specific operation:

stored [-1] [-c] [-n] [-v [-v]]

To run stored as a daemon process:

stored [-d] [-v [-v]]

Options

The options for this command are:

Option	Description
-c	Performs one cleanup pass to erase expunged messages. Run once, then exits. The -c option is a one-time operation, so you do not need to specify the -1 option.
-d	Run as daemon. Performs system checks and activates alarms, deadlock detection, and database repair.
-1 (the number one)	Run once, then exit.
-n	Run in trial mode only. Does not actually age or cleanup messages. Runs once, then exits.
-v	Verbose output.
-v -v	More verbose output.

Examples

To test expiration policies:

stored -n

To perform a single aging and cleanup pass:

stored -l -v