Email Collection

Email Collections can index content from PST files including attachments and documents from file-systems. It is recommended to index only PST files using this collection.

Creating Email Collection

You can Create a Email Collection with the following steps:

  • After logging in to the Admin Console, select the Collections tab and click on Create a New
    Collection or "+" icon.
  • Choose Email Collection as Collection Type
  • Enter a unique name for the collection (for example, Email Archive).
  • Choose Private/Public Collection Access and Collection Encryption as per the requirements.
  • Choose the language of the content.
  • Click on Save to create a collection.
  • Once the Email collection is created you will be taken to the Path tab.

The email collection settings page allows you to configure the directory paths and filters for the collection. To access the paths settings for the collection, click on the collection name in the collections list.

Email Collection Path Settings

Directory Paths

The directory path is the starting path for the crawler. The crawler recursively indexes files within the folders. Enter at least one directory path for the collection. For example, c:\salesdocs or /var/web/html/salesdocs

Allow/Disallow Paths

Allow and Disallow filters make it possible to manage a collection by excluding unwanted documents.

Directory PathThe directory path is the starting path for the crawler.
Allow PathsC:\\www\\html\\*
When creating an email collection, specifying an allow filter is optional since the indexer is only going to look into sub-folders, but if any symbolic links are placed, the spider will move to linked directories.
Disallow PathsC:\\www\\html\\noindex\\.*
Allowed FormatsSelect which formats are eligible to be part of the collection using the checkboxes.
File formats supported in email collection are HTML, XML, Word, Powerpoint, Excel, Visio, PDF, Text, RTF, EPUB, AutoCAD, OpenOffice, iWorks, WordPerfect, Images, Audio, Video, PST files, Email, and Archive.

Email Collection Settings

The Settings sub-tab holds tunable parameters for the email collection. SearchBlox comes pre-configured with parameters when a new collection is created.

The settings that can be configured are listed as follows:

Remove DuplicatesWhen enabled, prevents indexing duplicate documents.
StemmingWhen stemming is enabled, inflected words are reduced to a root form. For example, "running", "runs", and "ran" are the inflected form of a run.
Spelling SuggestionsProvide spelling suggestions for the collection. The default is YES.
Keyword-in-Context DisplayThe keyword-in-context returns search results with the description displayed from content areas where the search term occurs.
HTML Parser SettingsThe setting configures the HTML parser to read the description for a document from one of the HTML tags: META, H1, H2, H3, H4, H5, H6.
Email Settings- All MailAllows crawler to index all the documents from all extracted PST folders. All Email is enabled by default.
Email Settings- PartiallyAllows the crawler to index all the documents from selected extracted PST folders. Partially includes the folder names Inbox, Outbox, Deleted Items, Drafts and Sent Mail. All the Custom email folders will fall under Others option.
Maximum Document Age Specifies the maximum allowable age in days of a document in the collection.
Maximum Document Size Specifies the maximum allowable size in kilobytes of a document in the collection.
Enable Detailed Log SettingsProvides the indexer activity in detail in ../webapps/ROOT/logs/index.log.

The details that occur in the index.log when logging or debug logging mode is enabled are:
- List of files that are crawled.
- Processing is done on each file along with timestamp on when the processing starts, whether the indexing process is taking place or URL gets skipped, and whether the file gets indexed. All data will be available as separate entries in index.log.
- Timestamp of when the indexing completed, and the time is taken for indexing across the indexed file entry in the log file.
- Last modified date of the file.
- If the file is skipped or not, and why.
Enable Content APIProvides the ability to crawl the document content with special characters included.

Extraction of Emails

  • You can extract emails as text and attachments in a specific folder (all emails and attachments will be exported to the specified location).
  • Location can be specified at <SEARCHBLOX_INSTALLATION_PATH>/webapps/searchblox/WEB-INF/pst.yml
  • Please restart SearchBlox after entering the storage location in pst.yml. Then clear and reindex the collection.

Schedule and Index

Sets the frequency and the start date/time for indexing a collection, from the root URLs. Schedule Frequency supported in SearchBlox is as follows:

  • Once
  • Hourly
  • Daily
  • Every 48 Hours
  • Every 96 Hours
  • Weekly
  • Monthly

The following operations can be performed in email collections:

ScheduleFor each collection, indexing can be scheduled based on the above options.

Data Fields Tab

Using Data Fields tab we can create custom fields for search and we can see the Default Data Fields with non-encrypted collection. SearchBlox supports 4 types of Data Fields as listed below:


  • Once the Data fields are configured, collection must be cleared and re-indexed to take effect.

To know more about Data Fields please refer to Data Fields Tab


Best Practices

  • If you need to use the extraction and download feature of email collection please make the required changes in pst.yml mentioned earlier, restart the instance and then index the collection.
  • If you have multiple collections, always schedule the activity to prevent more than 2-3 collections indexing or refreshing at the same time.