Sun Java System Messaging Server 6.3 Administration Reference

msuserpurge

When user and domain mailboxes are marked for deletion, the msuserpurge command purges those user and domain mailboxes from the message store. Specifically, this command scans the following domain and user status attributes in LDAP for a value of deleted: inetDomainStatus, mailDomainStatus, inetUserStatus, mailUserStatus. This command can be run at the command line, or can be scheduled for execution with the configutil parameter local.sched.userpurge.

Requirements: If run manually, it must be manually run locally on the messaging server. Make sure that the environment variable CONFIGROOT is set to msg-svr-base/config.

Location: msg-svr-base/lib

Syntax


msuserpurge [-d domain_name] [-g grace_period]

Options

The options for this command are:

Option  

Description  

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

Examples


msuserpurge -d siroe.com -g 0