General tab

Use this tab to define the set of criteria according to which the component will search for email messages in the associated account.
Option Description
Name Specify an alias name that will be used as identifier of the class in the configuration.
Search location This group allows setting the location for search.
Inbox Select this option to search in the Inbox folder of the account.
Search specific folders/subfolders Select this option if you want the component to search for messages in specific folders and/or subfolders. In the text box next to this option, enter a semicolon-separated list of desired folders.
Search all subfolders Select this check box to enable search in all subfolders of the folders specified for the search in this class: either Inbox folder, or a number of other user-defined folders.

When this check box is selected, the component will search messages in all subfolders of all levels of the specified folders; otherwise, the search will be performed only in the specified folders.

Search criteria This group allows you to specify search criteria for the class.

All specified search criteria will be combined into a single IMAP search query string using 'AND' operator.

To add a criterion, select the desired check box and enter the value in the text field next to the check box.

Note: The component performs a case-insensitive substring search for text fields.
Subject The string that will be searched in the SUBJECT field.

This is a text field.

From The string that will be searched for in the FROM field.

This is a text field.

Body The string that will be searched for in the body of the message.

This is a text field.

Smaller Messages with the [RFC-2822] size smaller than the specified number.
Larger Messages with the [RFC-2822] size larger than the specified number.
Newer than Messages that were received no later than the specified number of days ago.
Older than Messages older than the specified number of days.
Custom Select this check box if you want to specify a custom IMAP query. In the text box, enter your query. Your custom query will be joined to the other criteria by a logical 'AND'.
Note: Use CTRL + Enter combination to enter a new line in the text box. When you use a new line in your query, the component interprets it as a single space symbol.

Possibility to enter a custom search query provides more flexibility for the user in specifying search criteria: the user can specify more parameters for searching desired mail messages than it is possible to do with the component options. Using a custom query, the user may specify for searching CC and BCC fields of the mail messages, as well as other information available for the message. The user may specify a list of possible values for the same criterion using a logical 'OR' operator, or the user may specify a restriction for a criterion using a logical 'NOT' operator. Both mentioned possibilities are available in the component only through custom search queries.

With this functionality, the component supports all standard IMAP search query keys. See more information on the IMAP search queries in IMAP search command of the IMAP protocol official specification.

Note: The support for 'UNSEEN' search key is provided by the component, although is redundant. By default, the component searches only for those email messages that do not have '\Seen' flag on the server, so using 'UNSEEN' query is not necessary. At the same time, the component never polls the messages with '\Seen' flag; hence, using 'NOT UNSEEN' query will lead to a situation in which the component will never poll any file by the configured class.

See more information on IMAP queries, supported by the component, in Custom Query.

Click the Test Query button to send a test query to the server to make sure the query is correct.

Create documents for In this group of options you can specify which parts of email messages will be passed to the subsequent components in the workflow.

The options work independently of each other. The total number of documents depends on which check boxes are selected:

  • Attachments adds as many documents as there are attachments.
  • Body adds one document.
  • HTML body as MHT adds one document if the message has HTML body.
  • Whole e-Mail message as EML adds one document.
Attachments Select this check box to create a new document for every attachment.
Body Select this check box to create a new document for HTML or plain text body of the message.
Note: If an email message has both HTML and plain text bodies, only HTML part of the message will be passed.
HTML body as MHT Select this check box to convert HTML body (including its related content) of the email message to MHT file and pass it as a separate document. If the message has no HTML body, the component will not create any document.
Whole email message as EML Select this check box to convert the email message (including its header, body, related content, and all attachments) to an EML file (also known as MIME) and pass it as a separate document.
Split jobs Use options in this group allow for configuring how the documents, created out of an email message, will be grouped and sent into the workflow. The number of documents depends on the options selected in the Create documents for group.

By default all documents are sent into the workflow as a group with associated RRTs.

Split documents to jobs Select this check box, if you want to create separate documents for workflow processing. Each document will be sent to the subsequent components as a single file along with the metadata (RRTs).
Add body as document to each job Select this option, if you want to add the message body to each created document, except for the document created from the body itself.
Delete message from server Select this check box, if you want to delete processed messages from the server after processing.