Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Mail Import

Import Provider Grooper.Messaging

Provides mail message import capabilities over the IMAP protocol.

Remarks

The Mail Import provider allows you to import email messages from IMAP mail servers into Batches in Grooper as electronic documents.

You can configure the connection to use SSL, specify authentication credentials, select one or more mailboxes, filter folders and messages, and control how emails are handled after import (such as moving, flagging, or deleting them).

Server Connection

  • Set the 'Mail Server' to specify the address of the IMAP server.
  • Provide the 'User Name' and 'Password' for authentication.
  • Enable 'Use SSL' for secure connections.
  • Set the 'Port No' (default is 993 for SSL, 143 for non-SSL).

Mailbox Selection

  • Enable 'Use Mailbox List' to import from multiple mailboxes.
  • Specify the list of mailboxes in the 'Mailboxes' property.
  • If disabled, only the default mailbox for the user will be processed.

Folder and Message Filtering

  • Set the 'Base Folder' to specify the root mail folder to import from (e.g., Inbox).
  • Enable 'Include Subfolders' to import from all nested folders.
  • Use 'Folder Inclusion Pattern' and 'Folder Exclusion Pattern' to filter folders by name using regular expressions.
  • Use 'Filter By Subject Line' to filter messages by subject using a regular expression.

Disposition

  • Choose how emails are handled after import using the 'Disposition' property:
    • NoChange: Leave emails in place.
    • Flag: Mark emails as read after import (enable 'Flag Emails as Read').
    • Move: Move emails to the specified 'Disposition Folder' after import.
    • Delete: Delete emails after import.
  • Some options are only available depending on the selected 'Disposition'.

Usage Notes

  • Ensure the Grooper service account has appropriate permissions to access the mail server and mailboxes.
  • When using 'Move' or 'Delete' disposition, 'Sparse Import' must be disabled.
  • The provider imports messages in RFC822 format, making them compatible with downstream Grooper activities such as Render and Recognize.

Properties

NameTypeDescription
Mail Server Connection
Multiple Mailbox Access
Mailbox Contents
Email Filtering
Disposition
Processing Options

See Also

Used By

Notification