› About configuring services › Email and Folder Watching Service › Email inbox watching

Email inbox watching

Configuring a new e-mail inbox watch happens through almost the same wizard interface via the same steps; only the first step needs to be configured differently.

In parallel with folder watching, email watching jobs also require Express connector profiles that use only such Document Services and Extenders that do not involve end-user interaction. Before you start watching setup, it is recommended that you have such Express connector profiles ready. If you are in doubt about your connector profile, document service and/or extender, it is recommended that you check its icon on top of the configuration page and review your setup in the Administration Console Simulator.

Once you have assigned an Express connector profile to a watching job, you cannot change it into a non-Express one.

To ensure that restarting email inbox folder watching jobs is an available option (in Job Monitor), it is also recommended that your email server is configured to keep the email messages on the server.

You can start the email inbox watching setup wizard from any of the following locations in the ShareScan Administration Console:

  • Click Watch email inbox via POP3 or Watch email inbox via IMAP in the Watching pane on the Devices tab.
  • Click Set up watching on the Home tab and select Watch email inbox via POP3 or Watch email inbox via IMAP from the button list.
  • Right-click on the Watching pane and choose Add Watch email inbox via POP3 or Watch email inbox via IMAP from the menu.

The New watcher - New Rule wizard starts. It is a good practice that you set up a separate inbox for all emails whose attachments you want to monitor.

  1. Set Watcher name: This field is mandatory.
  2. Set Processing order:
    • Parallel: When selecting this option, the attachments of emails in the Watch email inbox are processed in parallel. Processing an attachment of an email that arrives in the Watch email inbox later can be finished earlier than processing an attachment of another email that arrives earlier.
    • First in, First out: When selecting this option, the email attachments in the Watch email inbox are processed one after another in the order of the arrival time. Processing the next email attachments in the Watch email inbox is started by the same email inbox watcher only if the processing of the previous email attachments has been finished.
  3. Configure the following:
    Setting Group Field Description
    Server Settings Email server The name of the POP3/IMAP mail server to be monitored.
      Port The port used to access the POP3/IMAP mail server.
      Security Connection security options
      Ignore Invalid SSL Certificate Ignore invalid certificates (revoked, untrusted root, expired).
      Use Modern Authentication connect to the mail server using token based authentication method using Token Vault tool.
      User ID The user name of the account to access the POP3/IMAP mail server (not available in case of Use Modern Authentication).
      Password The password of the account to access the POP3/IMAP mail server (not available in case of Use Modern Authentication).
    Token Vault

    (only available for Use Modern Authentication)

    		User name The domain user name connecting to Token Vault.
      Password The password of the domain user connecting to Token Vault.
      Domain The domain of the user connecting to Token Vault.
      Authorization Provider ID The identifier of the Token Vault authorization provider that is associated with this watcher.
    Behavior

    (only available for IMAP configuration)

    		Delete non-matching mails Deletes mails with non-matching attachments.
      Folder The folders to watch on the IMAP mail server, for example, Inbox;Inbox\Folder1;Inbox\Folder2.
      Move failed jobs to The failed jobs are moved to this folder on the IMAP mail server.
    In case Watch e-mail inbox via IMAP is configured, if the processed e-mail contains more than one attachment and the watcher failed to process one (or more) attachment(s), the whole e-mail will be moved with all attachments.
    The watcher service must be restarted after modifying a Token Vault Authorization provider which id is configured for a POP3/IMAP email inbox watcher in order to use the proper authentication tokens in email inbox watcher workflows.
  4. Click Next or Schedule watching to continue.

The Schedule watching panel is displayed.

  1. Specify the following settings:
    1. Scheduling interval (s): how often search for input files should run
    2. Scheduling from: starting time of scheduling
    3. Scheduling to: end time of scheduling. Note that a maximum period of 1day (23:59) can be set as scheduling interval
  2. Click Next or Set processing rules to continue. The Set processing rules panel is displayed. Specify the following settings:
    1. Set Rule name: This field is mandatory.
    2. Set Priority: Provide a value between 1 to 5 to manage potential conflicts between rules watching the same folder with overlapping filters (for instance, two rules that both take PDF files as input). In such cases the higher priority rule processes the input file. The highest priority value is 1. It is strongly recommended that you use different priority settings for your potentially conflicting rules.
    3. Select the processing mode:
      1. Process as (scanned) images: This mode processes incoming files as if they are all actual scans - that is, all scanning-related operations and transformations (for instance deskew, ocr, bates stamping, and so on) set in the assigned connector profile are carried out on them. Pages processed as (scanned) images are included in the total page count.
      2. Route to destination without processing: Use this mode if you want to pass your files to their destinations without processing and/or transformation. (Your scans will be stored in their native file format.) Routing renames the files. To apply new naming, use Advanced File Naming (under Document Naming Option in the assigned connector profile).

    4. For either option, you can assign the filetypes to be handled by the rule. Simply mark the extensions you want to be handled by your rule.

      Since e-mail attachments not matching any of the rules are removed, it is recommended that you set up other, "secondary" rules to collect these files. Assign these secondary rules a lower priority (higher number) than your primary rules, and have them cover all file extensions that are not handled by your other rules targeting the same inbox. Choose the routing processing mode for these rules and use such connectors as Scan to File or Quick Connect for file delivery.

      To modify your list of choices, click the Edit button to reach the filetype editing dialog. Select/deselect filetypes as needed and confirm your choice with any of the following buttons:

      • Add: Type the extension into the field, and click this button.
      • Remove Selected: Mark the extensions to be removed from the list and click this button. You can remove any of the factory default supplied extensions as well as the ones you have added.
      • Cancel: Discard changes.
      • Save & Close: Confirm your updates and return to the wizard panel.
    5. Click Next or Add more filters to continue.

The Additional filtering panel is shown.

  1. Use these options only if you want to include or exclude files with specific names. Your options are:
    • Only include files named
    • Exclude files named

      Name filters must be in the format filtername*.

  2. Click Next or Associate with a profile to proceed.

In the next panel, you can associate an Express connector profile with the watch folder. This will process the incoming files. Please note that it can use only such Document Services that do not involve end-user interaction.

  1. Select a connector profile.
  2. Click Next or Set post-processing options to proceed.

In this panel you can configure the following:

  1. Set Rule owner: this is the person to whom the rule is assigned. To set up multiple owners, list them separated by semicolons, in the domain\user format.

    When you specify the Rule owner, take extra caution that you type in an Active Directory user correctly.

  2. Configure the Send notification to option, if applicable: provide notification email address.
  3. Choose what type of notification email to receive:
    • On successful processing
    • On failed processing
  4. Set what happens to processed files - configure the Processed files will be: option as follows:
    • Deleted: files are deleted after processing
    • Moved to: files are moved to a specified folder, or kept in the watch folder. This folder must be accessible to the account running the watcher service.
  5. Click Next to proceed.
  6. Review the full summary of your rule and click GO! to apply the rule.

Recommendations:

To achieve failover capabilities and load balancing benefits, it is recommended to employ more than one watcher monitoring the same inbox. In such cases the only supported configuration is that these watchers run on different ShareScan Managers, and these Managers use the same database.