Child pages
  • UAPI Functions - Email::fts_rescan_mailbox
Skip to end of metadata
Go to start of metadata

Description

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.


Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/fts_rescan_mailbox?account=username%40example.com


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Request that the IMAP Full-Text Search Indexing (powered by Apache Solr™) plugin rescan an email account.
$system_filters = $cpanel->uapi(
    'Email', 'fts_rescan_mailbox',
    array(
         'account' => 'username@example.com',
         )
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Request that the IMAP Full-Text Search Indexing (powered by Apache Solr™) plugin rescan an email account.
my $system_filters = $cpliveapi->uapi(
    'Email', 'fts_rescan_mailbox',
    {
        'account' => 'username@example.com'
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Template Toolkit
<!-- Request that the IMAP Full-Text Search Indexing (powered by Apache Solr™) plugin rescan an email account. -->
[% execute( 'Email', 'fts_rescan_mailbox', { 'account' => 'username@example.com' }) %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username Email fts_rescan_mailbox account=username%40example.com


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
      "status" : 1,
      "messages" : null,
      "errors" : null,
      "data" : null
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

Required

The email user's account name.

Note:

You must enter a valid email address. Otherwise, the function rescans the default email account.

A valid user email account.username@example.com

Returns

ReturnTypeDescriptionPossible valuesExample
statusBoolean

Whether the a rescan initiated.

  • 1 — Success.
  • 0 — Failure.
1