Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
The rescan_user_dovecot_fts Script - Version 82 Documentation - cPanel Documentation
Page tree
For cPanel & WHM version 82.

Skip to end of metadata
Go to start of metadata


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.


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

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

How to call the rescan_user_dovecot_fts script

Run the /usr/local/cpanel/scripts/rescan_user_dovecot_fts script with the following flag:



The user account that owns the mailboxes which you wish to scan.



The system treats each flag individually. If you pass an invalid value with a flag, the script will fail.

For example, if you wish to scan the example mailbox, run the following command:

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

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