v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

Email Server Information

Start IMAP Full-Text Search scan for email account

This function requests that the IMAP Full-Text Search Indexing (powered by Apache Solr™) plugin rescan an email account.

Note:

To enable this function, you must install the IMAP Full-Text Search Indexing (powered by Apache Solr™) plugin in WHM's Manage Plugins interface (WHM >> Home >> cPanel >> Manage Plugins). For more information, read our install_dovecot_fts script documentation.

Important:

When you disable the Receive Mail role, the system disables this function.

get/Email/fts_rescan_mailbox

Query parameters

accountstring email required

Example:username@example.com

The email user's account name.

Note:

If you do not enter an email address, the function rescans the default email account.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "fts_rescan_mailbox",
  "module": "Email",
  "result": {
    "data": 1,
    "status": 1
  }
}