The rescan_user_dovecot_fts Script

Valid for versions 82 through the latest version

Version:

82


Last modified: May 13, 2020

Overview

You can use the /usr/local/cpanel/scripts/rescan_user_dovecot_fts script to perform a full text search (FTS) scan on an account’s mailboxes.

Important:

If the cpanel-dovecot-solr RPM does not exist on the server, you will receive the following error message:

1
2
/usr/local/cpanel/scripts/rescan_user_dovecot_fts --user=example
The 'cpanel-dovecot-solr' rpm is not installed. Full text search rescan not possible

Run the script

To run this script on the command line, use the following format:

/usr/local/cpanel/scripts/rescan_user_dovecot_fts --user username

Options

Use the following options with this script:

Options Description Example
--user Required - The user account that owns the mailboxes which you wish to scan. /usr/local/cpanel/scripts/rescan_user_dovecot_fts --user example
Important:
The system treats each flag individually. If you pass an invalid value with a flag, the script will fail.

Success

If the script succeeds, it will return output similar to the following example:

Rescanning mailboxes for full text search indexing for 'example'……4 rescanned Done

Additional Documentation