Command Descriptions

# ./configutil -H

Configuration option: alarm.diskavail.msgalarmdescription
        Description: Description for the diskavail alarm.
        Syntax: string
        Default: percentage mail partition diskspace available
alarm.diskavail.msgalarmdescription is currently set to: percentage mail
partition diskspace available

Configuration option: alarm.diskavail.msgalarmstatinterval
        Description: Interval in seconds between disk availability
checks. Set to 0 to disable checks of disk usage.
        Syntax: int
        Default: 3600
alarm.diskavail.msgalarmstatinterval is currently set to: 3600
[.....]

### Show help on all configuration parameters ending in ".port" 

# ./configutil -p \*.port -H
Configuration option: local.ens.port
        Description: Port (and optionally, a specific IP address) ENS
server will listen on, in the format of [address:]port, for example,
7997 or 192.168.1.1:7997.
        Syntax: string
        Default: 7997
local.ens.port is currently set to: 7997

Configuration option: local.service.http.proxy.port
        Description: Configures the port number of the back-end
Messenger Express (HTTP) server with the Messaging Multiplexor.
        Syntax: uint
        Default: 80
local.service.http.proxy.port is currently set to: 80

Configuration option: local.snmp.port
        Description: SNMP subagent port number.
        Syntax: uint
        Default: 0
local.snmp.port is currently set to: 0

Configuration option: local.watcher.port
        Description: watcher listen port.
        Syntax: uint
        Default: 49994
local.watcher.port is currently set to: 49994

Configuration option: local.webmail.cert.port
        Description: Specifies a port number on the machine where the
Messaging Server runs to use for CRL communication. This port is used
locally for that machine only. The value must be greater than 1024.
        Syntax: int
        Default: 55443
local.webmail.cert.port is currently set to: 55443

Configuration option: local.webmail.da.port
        Description: Delegated Administrator port.
        Syntax: int
        Default: 8080
local.webmail.da.port is currently set to: 8080

Configuration option: local.webmail.sieve.port
        Description: The port of the web container where the Mail Filter
has been deployed.
        Syntax: string
        Default: NULL (unset)
local.webmail.sieve.port is currently unset

Configuration option: metermaid.config.port
        Description: Port number on which MeterMaid listens for
connections.
        Syntax: tcpport
        Default: 63837
metermaid.config.port is currently set to: 63837

Configuration option: service.http.port
        Description: Messenger Express HTTP port.
        Flags: MSG_RESTART_HTTP
        Syntax: uint
        Default: 80
service.http.port is currently set to: 81

Configuration option: service.imap.port
        Description: IMAP server port number.
        Flags: MSG_RESTART_IMAP
        Syntax: uint
        Default: 143
service.imap.port is currently set to: 143

Configuration option: service.pop.port
        Description: POP server port number.
        Flags: MSG_RESTART_POP
        Syntax: uint
        Default: 110
service.pop.port is currently set to: 110

### Show help on store.partition.\*.path

# ./configutil -p store.partition.\*.path -H
Configuration option: store.partition.*.path
        Description: Controls the store index file directory path.
        Flags: MSG_RESTART_ALL
        Syntax: filepath
        Default: NULL (unset)
store.partition.primary.path is currently set
to: /opt/SUNWmsgsr/data/store/partition/primary
store.partition.three.path is currently set
to: /opt/SUNWmsgsr/data/store/partition/three
store.partition.two.path is currently set
to: /opt/SUNWmsgsr/data/store/partition/two

Configuration option: store.partition.primary.path
        Description: Full path name of the primary partition.
        Flags: MSG_RESTART_ALL
        Syntax: filepath
        Default: <msg.RootPath>/data/store/partition/primary
store.partition.primary.path is currently set
to: /opt/SUNWmsgsr/data/store/partition/primary

configutil [-h] [-f configfile] [-o option[;language] [-v value]
configutil [-f configfile] [-p pattern] [-H] [-m] [-V]
configutil -i inputfile

-d

Enables you to delete an option. Used with the -o option.

-f configfile

Enables you to specify a local configuration file other than the default. (This option uses information stored in the CONFIGROOT environment variable by default.)

-h

Shows usage statement. 

-H 

Enables you to get help on options. Used with the -o option.

-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. The inputfile should be specified as an absolute path.

-m

Lists meta data. 

-o option

Specifies the name of the configuration parameter that you wish to view or modify. May be used with the -H, -v, -d options. Configuration parameter names starting with the word local are stored in the local server configuration file.

-p pattern

Lists only options with the given pattern (* is wildcard). Example: configutil - p \*enable -H

If no wildcard is present in the pattern, a wildcard at the end of the pattern will be assumed (effectively changing pattern to pattern\*).

-v value

Specifies a value for a configuration parameter. To be used with -o option.

-V

Enables you to validate the configuration against meta data. 

configutil

configutil -i config.cfg

configutil -p service.imap

configutil -o service.smtp.port

configutil -o service.smtp.port -v 25

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

configutil -m -p service.pop

service.pop.allowanonymouslogin = no [REFRESHABLE]
service.pop.banner = "%h %p service (%P %V)" [REFRESHABLE]
service.pop.createtimestamp = 20030315011827Z [REFRESHABLE]
service.pop.creatorsname = "cn=directory manager" [REFRESHABLE]
service.pop.enable = yes [NOT REFRESHABLE]
service.pop.enablesslport = no [NOT REFRESHABLE]
service.pop.idletimeout = 10 [REFRESHABLE]
service.pop.maxsessions = 600 [NOT REFRESHABLE]
service.pop.maxthreads = 250 [NOT REFRESHABLE]

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

counterutil -l 

counterutil -o counterobject [-i interval] [-n numiterations]
counterutil -s -o counterobject -c counter

-c counter

Specifies a particular counter associated with a counter object. 

-i interval

Specifies, in seconds, the interval between reports. The default is 5.

-l

Lists the content of the counter registry. 

-n numiterations

Specifies the number of iterations. The default is infinity. 

-o counterobject

Displays the contents of a particular counter object at specified intervals (by default, every 5 seconds). The valid counter objects are: 

imapstat

popstat

httpstat

alarm

diskusage

serverresponse

Each counter object has a list of counters. When you monitor a counter object, counterutil displays the counters associated with it.

-s

Resets the counter to 0. 

counterutil -l

counterutil -o imapstat

counterutil -s -o imapstat -c global.maxconnections

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

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

-F

Bypasses the access control check, whether or not user IDs are specified. If the destination mailbox does not grant the POST (“p”) right to the sender (the authid specified with the -a option), this option delivers mail to the inbox.

Use this option to force the message to be delivered to the destination mailbox, regardless of the access control on the inbox, and whether or not user IDs are specified with the userid option.

-l

Delivers 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 “p” right to the value of authid passed in with the -a option or if the -m option is not specified, then this option delivers mail to the inbox for the userid, 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 “p” right to the value of the authid passed in with the -a option, the delivery fails.

• When using deliver -m mailbox userid, mailbox can just be the IMAP folder name, but when using deliver -m mailbox, mailbox must be in the format user/userid/folder

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

deliver -m tasks fred < message

hashdir [-a] [-i] account_name

-a

Appends the directory name to the output. 

-i

Allows you to use the command in interactive mode. 

hashdir user1

imarchive [-s] [-v] [-p dir] 

-p dir

Processes archive reports in the specified directory. 

-s

Replaces archived messages with stubs 

-v

Provides verbose logging information. 

imarchive -s -b 200

imcheck [-m mailbox [-c messagenum] | -p partition | -f file] [-e] [-D [-S separator]]

imcheck -d databasename 

imcheck -s [-n]

-c messagenum

Prints cache data for the specified message number. 

-d databasename

Dumps the contents of the database specified by databasename.

-D

Dumps metadata in imsbackup format to verify the success of the backup operation.

-e

Prints the uids of expunged messages. 

-f file

Prints metadata for the mailboxes listed in the specified file. You must specify a full path name for file.

-m mailbox

Prints metadata for the specified mailbox. For information about the output produced by this option, see imcheck —m Metadata Output

-n

Specifies that no locking will occur. This option should be used only for debugging database hang problems. 

Do not use this option when the database is not hung; it can cause data corruption in the message store.

-p partition

Prints metadata for every mailbox in the specified message store partition. 

-s

Prints database statistics. 

-S separator

Specifies an output field separator. The default value is a vertical bar: “|”. 

imcheck -D -S : -m /user/jdoe/INBOX

imcheck -d folder.db

imcheck -m user/jdoe/INBOX 
--------------------------------------------------------------
Name: user/jdoe
Version: 102
Exists: 10
Flags: 0
Largest Msg: 1094 bytes
Last Append: 20060623164746
Last UID: 1008276527
Oldest Msg: 20000621093214
Oldest Uid: 2
Quota Used: 10061
UID Validity: 1008099930
Cache Offset: 7856
Start Offset: 256
ACL: jdoe      lrswipcda
Userflags:
  f1
  f2
  f3
  f4
  f5
  f6
Subscribed: 0
Partition: primary
Path: /var/opt/SUNWmsgsr/store/partition/primary/=user/64/b1/=jdoe
Msg Path: /var/opt/SUNWmsgsr/store/partition/primary/=user/64/b1/=jdoe

 MsgNo    Uid  Internal Date      Sent Date     Size HSize CacheOff  
Last Updated      Save Date MT  SFlags UFlags   Original-Uid   
Message-id
-----------------------------------------------------------------------
     1      2 20000621093214 19980719234108     1094   768     7856
20060621104501 20060621104501  0 0010000 000000 1008099883-2     
<0EWD00M09RWKOY@dumbo.sesta.com>
     2      3 20000621093214 19980719234108     1094   768     9468
20060621104501 20060621104501  0 0010000 000000 1008099930-3     
<0EWD00M09RWKOY@dumbo.sesta.com>
     3      4 20000621093214 19980719234108     1094   768    11080
20060621104501 20060621104501  0 0010000 3f0000 1008099930-4     
<0EWD00M09RWKOY@dumbo.sesta.com>

imexpire [-c | -e] [-n] [-d] [-v num] [-p partition | -u user]
[-t num][-r num] [-m num] [-f file]

imexpire -i {-p partition | -x mailbox} -f file

-c

Do purge (clean up) only—do not expire. Remove expunged and expired messages. 

-e

Do expire only—do not purge. 

-f file

Use the expire rules specified in file. All other expire rules are ignored.

When used with the -i option, -f file refers to the expire-rule file to be installed.

Use a full path name to specify file. The expire rules in file must use the same format as the rules in the global expire configuration file.

-i  

Install a local expire-rule configuration file. This option must be used with either the -p partition option to specify a message store partition or the -x mailbox option to specify a mailbox. In addition, it must be used with the -f file option to specify the expire rule file to install.

-n

Trial run only—do not perform expire or cleanup. A description of what would happen without this flag is output. 

-v 0|1|2

Log expire statistic. The number specifies the loglevel, where 

0= store level 

2 = mailbox level 

3 = message level 

Messages are logged to the log file by default. When the -d option is used, messages go to stdout.

-d

Display debug output to stdout/stderr.

-p message_store_partition

Expire/Purge the message store partition specified. 

-u user

Expire/Purge the specified user. 

-t num

Maximum number of threads per process. Default is 50.

-r num

Maximum number of threads per partition. Default is 1.

-m num

Maximum number of rules in a policy. Default is 128.

-x mailbox

Name of the mailbox to which the local expire rules apply. This option is used with the -i option to install a local configuration file that will expire messages in the specified mailbox and its sub-folders.

imexpire -c -v

imexpire -i -x user/jdoe/memos 
-f /home/jdoe/store.expirerule

iminitquota -a | -q | -s | -u userid

-a

Initializes and updates the quota files for every message store user. 

-q

Initializes quota only. 

-s

Initializes quota, usage, and overquota status. 

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

-u user_name

The valid test user account to use. This test mail user has to be created by the administrator. If the test mail user is in a hosted domain, user@domain should be specified.

-w passwd

The password corresponding to the user specified with -u. This option is mandatory when the -I or -P is used. “-” can specified with -w, to enter the password through standard input.

-L LDAP_host: [ port ] = [ threshold ]

Use the LDAP server and the port specified to check the Directory Server. The threshold is specified in seconds. 

-I IMAP_host: [ port ] = [ threshold ]

Use the IMAP server and the port specified to check the IMAP component of the Message Access. The threshold is specified in seconds. The threshold involves the time to login, retrieve, and delete the message. 

-P POP_host: [ port ] = [ threshold ]

Use the POP server and the port specified to check the POP component of the Message Access. The threshold is specified in seconds. The threshold involves the time to login, retrieve, and delete the message. 

-S SMTP_host: [ port ] = [ threshold ]

Use the SMTP server and the port specified to check if Messaging Server is able to accept mail for delivery. The threshold is specified in seconds. 

-C LMTP_host: [ port ] = [ threshold ]

Use the LMTP server and the port specified to check if Messaging Server is able to deliver the message to the store. The threshold is specified in seconds. 

-H HTTP_host: [port] = [ threshold ]

Use the HTTP server and the port specified to check if the HTTP server is able to accept requests on the specified port. When -I -H or -P is used, it is necessary to provide the test user password with -w. When -S/-C, -I/-P are specified together, the command does the following:

- sends mail and retrieves with IMAP and POP 

- reports the per protocol response time 

- reports round-trip time o reports delivery time (the time taken to send the mail and be visible to IMAP/POP) 

Multiple -I, -P, and -S options can be specified, which helps in monitoring Messaging Server on various systems.

-b searchbase

Use search base as the starting point for the searching in the Directory Server. It is the same as -b of ldap-search(1). If -b is not specified, the utility uses the value of dcRoot of the configuration parameter local.ugldapbasedn.

-f mail From option:

When immonitor-access sends out an e-mail, it usually is sent as root@domainname. Specify this option to send out an e-mail as different user: -f user@red.iplanet.com

-D threshold

The delivery (also called round-trip time) threshold. The time taken to send the mail and the mail being visible to POP/IMAP. This option can be used only when -I/-P and -S/-C are used.

-h

Prints command usage syntax. 

-i inputfile

Read the command information from a file instead of from the command line. 

-m file

The file that is mailed to the test user. You can get response and round-trip times for various mail sizes with this option. Specify only text files as non-text files result in unexpected behavior. If -m is not specified, the mailfile.txt file in msg-svr-base/lib/locale/C/mailfile.txt is used as the mail file.

-k subject

Header subject of the messages to be sent/deleted. The utility, by default, uses the string “immonitor:<date>” as the subject in the header sent out with the -S option. If -k is specified, the string “immonitor:subject” is used in the subject header.

This option can be used with -z to delete messages, if -k is not specified, all messages with the Subject header containing “immonitor” are deleted.

-z

Delete messages containing the string specified by -k in the subject header. If -k is not specified, all messages with the subject header containing “immonitor” are deleted. Use -z only with -I or -P. Do note use -z with -S or -C as this can cause unexpected results.

-r alert_recipients

A comma-separated list of mail recipients who will be notified. If this option is not specified, the command reports the alert messages on the standard output. 

-A host

The alternate mail server to be used to send mail to the alert_recipients. This option helps in sending alert messages even when the primary mail server is down or heavily loaded. If -A is not specified, the SMTP server on the localhost is used.

-h

Display the usage message. 

-d

The debug mode: display the execution steps. 

-v

Run in verbose mode, with diagnostics written to standard output. 

Smtp Statistics for: thestork:25
Connect Time: 2.122 ms
Greeting Time: 5.729 ms
Helo Time: 2.420 ms
Mail From: Time: 2.779 ms
Rcpt To: Time: 4.128 ms
Data Time: 1.268 ms 
Sending File Time: 94.156 ms
Quit Time: 0.886 ms
Total SMTP Time: 113.488 Milliseconds

immonitor-access -L localhost:=60.25 -S \
localhost:=60.25 -I localhost:=60.25 -P localhost:=60.25 \
-u test_user -w passwd

0 

Successful execution with no errors or thresholds exceeded 

1 

Exceeded threshold of a service 

2 

Errors 

64 

Usage errors 

cat passwd_file | immonitor-access -w -
immonitor-access -w - ... < passwd_file

imquotacheck [-u user | -d domain]  [-a]

imquotacheck -f [-d domain]

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

-a

Lists users in the LDAP directory. If the -a option is not used, imquotacheck lists users in the message store (the local mboxlist database).

-d domain

Searches for users only in the specified domain. 

When used with the -f option, the -d domain option enforces quotas for the specified domain.

When used with the -n option, the -d domain option delivers over-quota notifications for users in the specified domain.

-f

Enforces domain quotas. If the domain is over quota and the mailDomainStatus attribute is currently set to active, the value will be reset to overquota, which will prevent mail from being accepted by the message store. If the domain is not over quota and the mailDomainStatus attribute is set to overquota, then the value will be changed to active, and mail will be accepted.

-h

Displays help for this command. 

-n

Sends notification messages based on the rules defined in the rulefile. If you do not define any rules with the -r option when you use the -n option, the default rulefile is used. If you have not set up a default rulefile and you do not define any rules when you use the -n option, you will receive an error.

The delivery agent’s quota warning mechanism needs to be turned off in order for the imquotacheck -n command to work, because the imquotacheck 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, set store.quotanotification to off.

-r rulefile

Specifies the set of rules to be used when you want to calculate quota usage. This option is used with the -n option.

If -r is not specified, a default rulefile can be used. To set up a default rulefile, copy the Sample Rulefile to msg-svr-base/config/imq.rulefile. See Rulefile Format.

-t message template

Notifies users when their mailbox quota is exceeded. This option is used with the -n option.

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 msg-svr-base/config.

-u user

Obtains the quota status of the specified user id. Cannot be used to specify multiple users. 

-D

Debug mode; displays the execution steps to stdout.

imquotacheck -n

imquotacheck -n -r myrulefile -t mytemplate.file

imquotacheck -f -d siroe.com

imquotacheck

imquotacheck -u user1

imquotacheck -d siroe.com

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

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

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

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

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.

notificationTriggerPercentage

Yes 

Specifies the consumed quota percentage that will trigger notification. Value should be unique and an integer. 

messageFile

No 

msg-svr-base/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 attribute.

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 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 */
 }

               

#
# Sample rulefile
#
[General]
mailQuotaAttribute=mailquota
reportMethod=/xx/yy/libzz.so:myReportMethod [for Solaris only ] 
/xx/yy/libzz.sl:myReportMethod [for HP-UX only]
\xx\yy\libzz.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
#

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

imsasm [standard_asm_arguments]

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

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

-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 dot “.” 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.

imsasm: INBOX

imsbackup -f device [-b blocking_factor] [-d YYYYMMDD [:HHMMSS]]
[-e encoding] [-u file] [-m linkcount] [-ivlgx] [ name ...]

-b blocking_factor

Everything written to the backup device is performed by blocks of the size 512xblocking_factor. The default is 20.

-d YYYYMMDD [:HHMMSS]

Date from which messages are to be backed up, expressed in YYYYMMDD [:HHMMSS]; for example, -d 19990501:131000 would backup messages stored from May 1, 1999 at 1:10 pm to the present. The default is to back up all the messages regardless of their dates.

-e encoding

Mailbox name encoding (example: IMAP_MODIFIED-UTF-7) 

-f device

Specifies the file name or device to which the backup is written. If device is ”-’, backup data is written to stdout.

-g

Debug mode. The output is written in the default log file not to the stdout. For the stdout, one should use -v.

-i

Ensures that all messages are backed up for a partial restore. Backs up every message multiple times if necessary. 

-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 a backup object file. This file contains the object names (entire message store, user, group, mailbox, and so on) to backup. See name for a list of backup object

-v

Executes the command in verbose mode. 

name

Can be 1) logical pathname of the backup object, 2) user ID, 3) message store mailbox name. Backup objects and paths: 

• Entire message store: /

• Message store partition: /partition_name (default: /primary)

• Backup group—a group of users defined with regular expressions in a configuration file. See To Create Backup Groups in Sun Java System Messaging Server 6.3 Administration Guide for details. Path: /partition_name/backup_group(/primary/user represents all users under primary).

• User: /partition_name/backup_group/user_ID

• Mailbox:/partition_name/backup_group/user_ID/mailbox_name

• Message:/partition_name/backup_group/user_ID/mailbox_name/msgID

User IDs: can be any user ID in the message store. If the user is not in the default domain, the user ID must be fully qualified (example: Wally@siroe.com). If user is in the default domain, the user ID can stand alone (example: Wally).

mailbox: An email folder. It is specified using the following message store internal name:

user/user_ID/folder_name.

Note that user is a message store keyword.

imsbackup -f /dev/rmt/0 /

imsbackup -f /dev/rmt/0 /primary/user/joe

imsbackup -f- /primary/groupA > backupfile

imsconnutil -c|-a [-s service] [-u uid] [-f filename] 

imsconnutil -k {-u uid | -f filename}

-c|-a|-k

At least one of -c or -a, or -k must be used.

-a

Last IMAP, POP, or http web mail client access (log in or log out) of user(s). -s does not affect the output of -a.

-c

List IMAPusers currently connected. 

-k

Disconnect users from IMAP and POP. Users logged on to Communications Express lose the underlying IMAP connection and, thus, are also disconnected.  

The -k option must be used with either the —u uid option to specify users to disconnect or the —f filename option to specify the users listed in filename.

Note that -k option may only work if IMAP IDLE is configured.

-s service

Can specify either imap or http as service to monitor. Only applies to -c option. POP is not available because POP users do not typically stay logged on.

-u uid

Specify a UID to monitor. If -u and -f are not listed, then all users are monitored. 

-f filename

File containing UIDs to monitor. Each UID must be on its own line. 

--v

Returns version of this tool. 

--h

Returns usage information. 

# imsconnutil -a 

# imsconnutil -a -c

imsexport -d dir -u user [-e encoding] [-g] [-s mailbox] [-v mode]

-d dir

Specifies the destination directory name where the folders will be created and written. This is a required option. 

-e encoding

Specify an encoding 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. The message store id is either userid (for default domain users) or userid@domain (for other users). 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.

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

imsimport -u user -s file [-c y|n] [-d mailbox] [-e encoding]
[-b] [-g] [-i] [-n] [-v mode]

-b 

Subscribes the destination mailbox folder when a new folder is created by the imsimport utility.

-c y|n

Provides an answer to the question: “Do you want to continue?” if an error occurs. Specify y for yes, n for no.

-d mailbox

Specifies the destination mailbox where the messages will be stored. 

-e encoding

Specify an encoding option. 

-g

Specifies debugging mode. 

-i

Ignores the content-length field 

-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 from which the messages are to be imported. The file parameter must be a full path name. This is a required option.

-u user

Specifies the message store identification for a user. Note that this should be identical in content and case to the UID attribute of the user's LDAP entry. If it is not the same, users will not be able to login to their INBOXES.  

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

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

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

imsrestore -f device|-  [-b blocking_factor] [-c y | n] 
[-d path] [-D] [-e encoding [-h] [-i] [-m file] 
[-n] [-p] [-r file] [-s] [-S] [-t] [-u file] [-v 0|1|2|3|4|5] 
[path] [-x]

-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

Provides an answer to the question: “Do you want to continue?” if an error occurs. Specify y for yes, n for no.

-d path

-e encoding

Mailbox name encoding (example: IMAP_MODIFIED-UTF-7) 

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

-g

Debug mode 

-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=xb=yc=z

where a, b, and c are old names and x, y, and z are new names. For users in a hosted domain, add @domain_name to the old and new user IDs.

This option is only used to rename user IDs when restoring from a Messaging Server 5.x or 6.x imsbackup file. Use the -u option when restoring from a SIMS 4.0 imbackup file.

-n

Creates a new mailbox with a .date extension (if the mailbox exists). By default, messages are appended to the existing mailbox.

-r file

Reference file name (will restore all links in file).

-s

Used to restore a large file without using large file seeking.  

-t

Prints a table of contents, but restore is not performed. 

-u file

Specifies a backup object file. This file contains the object names (entire message store, user, group, mailbox, and so on) to restore. See name for a list of backup objects.

For restoring SIMS data into a Sun Java System Message Store, you can specify or rename users with -u file. Users should have one name per line. If you rename users, the format of file is oldname=newname with one set of names per line. For example:

joebonniejackie=jackie1

where joe and bonnie are restored, and jackie is restored and renamed to jackie1. Note that full object pathnames are not needed for user IDs.

-v [0|1|2|3|4|5]

Executes the command in verbose mode. 

0= no output

1= output at mailbox level

2= output at message level (default)

3= print meta data (for use with -t only)

4=print object level meta data (for use with -t only)

5=print the backup data of mailboxes and messages (for use with -t only)

-x

Restores stubs into message files. 

name

Can be 1) logical pathname of the backup object, 2) user ID, 3) mailbox. See imsbackup for description.

imsrestore -f backupfile

imsrestore -f backupfile /primary/user/joe

imsrestore -f backupfile -t

imsrestore -m mapfile -f backupfile

userA=user1
userB=user2
userC=user3

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

-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 -l [-p MUTF7 IMAP pattern | -P regular expression] [-x | -s]

mboxutil -c {mailbox | -f file}

mboxutil -d {mailbox | -p MUTF7 IMAP pattern | -P regular expression | -f file}

mboxutil -R [-t hours] mailbox

mboxutil -r {oldname newname | -f file } [partition]

mboxutil -e [-p MUTF7 IMAP pattern | -P regular expression ]

mboxutil {-c | -d } [-f file ]

mboxutil -o [-w file ] [-t days] 

mboxutil -S [-n [-f file] | -u -f file]

mboxutil -l [-p MUTF7 IMAP pattern |-P regular expression] [-x] 

-a

Obsolete. Used to list all user quota information. Use. imquotacheck

-c mailbox

Creates the specified mailbox. 

A mailbox must exist before creating a secondary mailbox. 

-d mailbox

Deletes the specified mailbox. 

To delete a user from the message store, use the following value for -d mailbox:

user/userid/INBOX

For example, to delete the user john from the message store, use -d user/john/INBOX. To delete the mm folder in the user john’s mailbox, use -d user/john/mm.

The recommended method to delete a user is to mark the user status as deleted in the LDAP directory (by using the Delegated Administrator utility commadmin user delete command or the Delegated Administrator console.). Next, remove resources from the user that have been marked as deleted for a period longer than a specified number of days by using the msuserpurge command for all mail services and csclean for all calendar services. Finally, use the commadmin domain purge command to permanently remove the users. .

For more information on removing users, see the following technical note: Deleting Messaging Server, Calendar Server, and Communications Express Users

If you use the Delegated Administrator utility as described in the preceding paragraph, you do not have to use the mboxutil -d command to delete a mailbox.

Note that -p and -P can be used in conjunction with one another.

-e

Expunges all deleted messages in the message store. This option also can be used with the -p pattern or -P regexp options to expunge all deleted mailboxes with names that match pattern or regexp.

-f file

Specifies a file that stores mailbox names. The -f option can be used with the -c, -r, -S, or -d options.

The 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/INBOXuser/daphne/projxuser/daphne/mm

-l

Lists all of the mailboxes on a server. 

mboxutil -l will correctly display characters associated with the system locale under which mboxutil is being executed. The -P regexp option will accept international characters.

-n 

Lists personal, non-existing mailbox subscriptions. The -n option is used with the -S option.

-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, mboxutil writes the following command to the standard output:

mboxutil-d user/userid/INBOX unless -w is specified

-p pattern

When used with the -l option, lists only those mailboxes with names that match pattern.

Can also be used with the -d or -e option to delete or expunge mailboxes with names that match pattern.

You can use IMAP wildcards. This option expects a pattern in IMAP M-UTF-7 format. This is not the recommended way to search for non ascii mailboxes. To search for non ascii mailboxes, use the -P option. 

-P regexp

Lists, deletes, or expunges only those mailboxes with names that match the specified POSIX regular expression. This option expects the regexp in the local character encoding.

-q domain

Obsolete. Use imquotacheck -d 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.

This option can be used to rename a user. For example, mboxutil -r user/user1/INBOX user/user2/INBOX moves all mail and mailboxes from user1 to user2, and new messages will appear in the new INBOX. (If user2 already exists, this operation will fail.)

-R mailbox

Restores deleted messages that have not yet been purged. 

When a mailbox is expunged or expired, the uids of the deleted messages are stored in a store.exp file. The messages are physically removed by imexpire after the cleanup age has passed. When expunge or expire is issued by mistake, this option can be used to restore the deleted messages that have not been purged by imexpire into the original mailbox.

-s

When used with the -l option, displays only the mailbox name. No other data is displayed.

-S 

Lists personal mailbox subscriptions. When used with the -n option, the -S option lists or unsubscribes non-existing mailbox subscriptions.

-t days

| hours

When used with the -o option, lists the mailboxes that have not been accessed in a specified number of days (days).

When used with the -R option, restores messages that were expunged in the last specified number of hours (hours). If the -R option is used without the -t option, all messages that were expunged or expired are restored, regardless of their age.

Thus, the -t option identifies inactive mailboxes (based on last-accessed date) together with orphaned mailboxes (mailboxes that do not have corresponding user entries in the LDAP directory).

To identify (list) the orphaned and inactive mailboxes, use mboxutil -o -w file -t num.

To mark these orphaned and inactive mailboxes for deletion, use mboxutil -d -f file, where file is the same file as the one passed to -w in the preceding command.

To use this feature, the config variable local.enablelastaccess must be enabled for at least the number of days specified with the -t option.

-u

Unsubscribe personal non-existing mailbox subscriptions listed in the file specified with the -f file option.

-w file

Used with the -o option. Writes to a file the mailbox names generated by the -o option (which identifies orphaned accounts).

-x

When used with the -l option, displays the path and access control for a mailbox.

mboxutil -l

mboxutil -l -x

mboxutil -l -s

mboxutil -c user/daphne/INBOX

mboxutil -d user/delilah/projx

mboxutil -d user/druscilla/INBOX

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

mboxutil -R -t 24 user/desdemona/memos 

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

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

mboxutil -o -w orphanfile -t 60

mboxutil -d -f orphanfile

mboxutil -S -n -f orphanfile

mboxutil -S -u -f orphanfile

BACKUP_ROOT

Message store administrator root directory. 

partition

Store partition. 

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 msg-svr-base/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. 

mailbox

Name of the user mailbox. 

groupA=a* (regexp)
groupB=b*
groupC=c*
.
.
.

mkbackupdir [-a name_of_asm] [-i | -f | -u] [-g] 
[-t number_of_threads] [-e encoding] [-v] -p directory

-a name_of_asm

Creates .nsr files using the specified asm name. This can be used for when you have multiple instances of Messaging Server as in symmetric HA environments.

-e encoding

Specify an encoding option. 

-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 when local.store.backupdir is not configured.

The max_thread parameter must be set between 1 and 1024. 

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.

-t number_of_threads

Specifies the number of threads that can be used to create the backup directory. The default is one thread for each partition, which is usually adequate. If you have many partitions, and you do not want mkbackupdir to consume all your resources, you can lower this number.

-u

User level backup. Instead of backing up each folder as a file, create a backup file per user. 

-v

Executes the command in verbose mode. 

mkbackupdir -p /mybackupdir

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]] [-a destproxyuser]

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

-i

Uses the IMAP command FETCH (RFC822) instead of FETCH (RFC822.HEADER RFC822.TEXT) to workaround problems with another vendor's IMAP server.

-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 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. This option does not update the directory or modify LDAP attributes. Only the -l option will modify attributes.

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

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

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

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

MoveUser -l \"ldap://server1.siroe.com:389/o=siroe.com???(uid=user1)"  \-s host1 -x admin -p password -d host2 -a admin \
-v password 

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

MoveUser -u joe -s oldserver -x joe -p joepassword -d newserver -a admin
 -v adminpassword

msuserpurge [-d domain_name] [-g grace_period]

-d domain_name

Specifies domain to check for deleted attribute, and, if set, purges the mailboxes in that domain. If -d is not specified, then all domains on this mail host are checked for the deleted attribute and all mailboxes in the deleted domains are purged. If the domain spans more than one mail host, then you need to run this command on each host. (This command uses the mailhost attribute to determine where to purge.)

-g grace_period

Specifies the number of days that a domain or user must be marked as deleted before this command is run. This option must be set. To purge users or domains immediately, set –g to 0.

msuserpurge -d siroe.com -g 0
            

readership [-d days |-p months |  -l | -s folder identifier right]

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

-l

List the shared folders shared to that specific user. 

-s folder identifier right

Setacl for folder. 

reconstruct [-n | -f] [-i] [-e] [-p partition] 
{-r [ mailbox...] | mailbox...}

reconstruct [-p partition [ -u user ] ] -m

reconstruct -l
reconstruct -q

-f

Forces reconstruct to perform a fix on the mailbox or mailboxes.

-l

Reconstruct lright.db.

-e

Removes the store.exp file before reconstructing. This eliminates any internal store record of removed messages which have not been cleaned out by the store process.

Running a reconstruct -e will not recover removed messages if reconstruct does not detect damage. A -f will force the reconstruct and -e to take effect, removing the store.exp file.

-i

Sets the store.idx file length to zero before reconstructing. 

Running a reconstruct -e will not recover removed messages if reconstruct does not detect damage. A -f will force the reconstruct and -e to take effect, removing the store.exp file.

-m

Performs a consistency check and, if needed, repairs 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/

-p partition

The -p option is used with the -m option and limits the scope of the reconstruction to the specified partition. If the -p option is not specified, reconstruct defaults to all partitions. Specifically it fixes folder.db and quota.db, but not lright.db. This is because fixing the lright.db requires scanning the acls for every user in the message store. Performing this for every partition is not very efficient. To fix lright.db run reconstruct -l.

Specify a partition name; do not use a full path name. 

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

-u user

The -u option is used with the -m option and limits the scope of the reconstruction to the specified user. The -u option must be used with the -p option. If the -u option is not specified, reconstruct defaults to all partitions or to the partition specified with the -p option.

Specify a user name; do not use a full path name. 

reconstruct user/dulcinea/INBOX

reconstruct -n user/dulcinea/INBOX

reconstruct -n -r

refresh [ -h | service]

-h

Show usage statement and list available services that can be refreshed. 

service

Refresh just the specified service. Accepted values are 

           watcher
           metermaid
           store
           imap
           pop
           cert
           http
           sched
           dispatcher
           job_controller
           mmp
           mta 

If no components are specified, all enabled services will be refreshed. 

refresh sched

relinker [-p partitionname] [-d]

-d

Specifies that the digest repository be deleted. 

-p partitionname

Specifies the partition to be relinked. (default: all partitions). 

# relinker

# relinker -d

start-msg [ -h | ha | service]

-h

Shows the usage statement: 

Usage: ./start-msg [COMPONENTS...]
         Start all or some Messaging Server components.
Usage: ./start-msg ha
         Start all Messaging Server components in HA mode. 

ha

Starts all Messaging Server components in HA mode.

service

The accepted values for service are:

         watcher
         mfagent
         ens
         metermaid
         store
         imap
         pop
         cert
         http
         sched
         dispatcher
         job_controller
         snmp
         sms
         mmp
         mta 

If no components are specified, all enabled services will be started. 

start-msg

start-msg imap

stop-msg [ -h | ha | [-f] service]            

-f

Force stop using SIGKILL.

-h

Shows the usage statement: 

Usage: ./stop-msg [OPTIONS] [COMPONENTS...]
         Stop all or some Messaging Server components.
Usage: ./stop-msg ha
         Stop all Messaging Server components in HA mode. 

ha

Stops all Messaging Server components in HA mode.

service

The accepted values for service are:

         watcher
         mfagent
         ens
         metermaid
         store
         imap
         pop
         cert
         http
         sched
         dispatcher
         job_controller
         snmp
         sms
         mmp
         mta

If no components are specified, all enabled services will be stopped. 

stop-msg            

stop-msg http

stored [-r] [-R] [-t] [-v]

-r

Removes the database temporary files and synchronizes the database. This cleans up the database environment to prepare for an upgrade, downgrade, or migration. 

-R

Removes the database temporary files without synchronizing the database. If stored -r fails because the software has been upgraded with an incompatible libdb, customers can run stored -R to remove the database temporary files. stored -R does not perform recovery.

-t

Checks the status of stored. The return code of this command indicates the status. To print the status, enter:

stored -t -v

-v

Verbose output.