The remove_dovecot_index_files 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/remove_dovecot_index_files script to remove the Dovecot® index logs and cache files from cPanel mail accounts. You could use this, for example, to remove corrupted index logs and cache files or to remove files that lost synchronization during a transfer.

Note:
The Dovecot service automatically regenerates an account’s index logs and cache files the next time an account logs in.

Run the script

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

/usr/local/cpanel/scripts/remove_dovecot_index_files --user username --reseller resellername --all  --verbose

Options

Use the following options with this script:

Options Description Example
--user The cPanel account that owns the mailboxes from which you wish to remove Dovecot index files. /usr/local/cpanel/scripts/remove_dovecot_index_files --user username
--reseller The reseller account that owns the cPanel accounts which owns the mailboxes from which you wish to remove Dovecot index files. /usr/local/cpanel/scripts/remove_dovecot_index_files --user username --reseller resellername
--all Remove Dovecot index files from all email accounts that exist on the server. /usr/local/cpanel/scripts/remove_dovecot_index_files --all
--verbose Return expanded output. /usr/local/cpanel/scripts/remove_dovecot_index_files --all --verbose
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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# /scripts/remove_dovecot_index_files --user example --verbose
...
Unlinking '/home/example/mail/.Sent/dovecot.index' 
Unlinking '/home/example/mail/.Sent/dovecot.index.log' 
Unlinking '/home/example/mail/.Drafts/dovecot.index.log' 
Unlinking '/home/example/mail/.Drafts/dovecot.index' 
Unlinking '/home/example/mail/.Junk/dovecot.index.log' 
Unlinking '/home/example/mail/.Junk/dovecot.index' 
Unlinking '/home/example/mail/.Trash/dovecot.index' 
Unlinking '/home/example/mail/.Trash/dovecot.index.log' 
Unlinking '/home/example/mail/.spam/dovecot.index.log' 
Unlinking '/home/example/mail/.spam/dovecot.index.cache' 
Unlinking '/home/example/mail/.mailbox_format.cpanel/dovecot.index.log' 
[+] 'example' processed.

Additional Documentation