Mail Import Mail ImportProvides mail message import capabilites over the IMAP protocol.
Mail messages are imported to Grooper as Electronic Documents using the RFC822 format. The Render activity can be used to generate a PDF version of the mail message and its attachments. This process will make the mail content viewable in Grooper. Recognize can then be used to generate OCR data, exposing email content to the full suite of Grooper classification and data extraction technologies. The Mail Import activity can be used to perform a variety of actions on mail messages, including metadata an attachment extraction.
NOTE: This Import Provider is depreciated. The Import Query Results or Import Descendants providers should be used in its place. To use Import Query Results or Import Descendants with IMAP, create a CMIS connection with the connection type 'IMAP'.
Inherits from: Import Provider
The following 26 properties are defined.
| Property Name | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Mail Server Connection | |||||||||||||||||||||||||||||||
| Mail Server | Type: String
The host name or IP address of an IMAP mail server. |
||||||||||||||||||||||||||||||
| User Name | Type: String
The user name to be used for logging in to the Mail Server. Note: The domain name may be required to access mailboxes. e.g. bis\grooperdemo. |
||||||||||||||||||||||||||||||
| Password | Type: String
The password to be used for logging in to the Mail Server. |
||||||||||||||||||||||||||||||
| Use SSL | Type: Boolean, Default: True
If true, the connection to the Mail Server will be established using SSL. |
||||||||||||||||||||||||||||||
| Port No | Type: Int32, Default: 993
The port number on which the IMAP server is running. The default port number for an SSL-enabled IMAP server is 993. With SSL disabled, the default port is 143. |
||||||||||||||||||||||||||||||
| Multiple Mailbox Access | |||||||||||||||||||||||||||||||
| Use Mailbox List | Type: Boolean, Default: False
Enables import from a list of mailboxes. If disabled, only the default mailbox associated with the provided login credentials will be processed. |
||||||||||||||||||||||||||||||
| Mailboxes | Type: String []
The set of mailboxes from which email will be imported. Each mailbox entry should be the name of the mailbox. e.g. JoeUser |
||||||||||||||||||||||||||||||
| Mailbox Contents | |||||||||||||||||||||||||||||||
| Base Folder | Type: String, Default: Inbox
The base mail folder to import from. |
||||||||||||||||||||||||||||||
| Include Subfolders | Type: Boolean, Default: False
Indicates whether subfolders below the Base Folder should be processed. |
||||||||||||||||||||||||||||||
| Folder Inclusion Data Type | Type: Data Type
If a Data Type is specified, only folder paths which generate a match will be processed. |
||||||||||||||||||||||||||||||
| Folder Exclusion Data Type | Type: Data Type
If a Data Type is specified, folder paths which generate a match will be skipped. |
||||||||||||||||||||||||||||||
| Email Filtering | |||||||||||||||||||||||||||||||
| IMAP Query | Type: String, Default: ALL
If non blank, an IMAP query that controls which mail messages will be retrieved from the specified mailboxes. If blank, then all mail messages will be retrieved from the specified mailboxes. The following table provides examples of simple IMAP query language:
|
||||||||||||||||||||||||||||||
| Filter By Subject Line | Type: String
If non blank, then a regular expression to filter email subject lines by |
||||||||||||||||||||||||||||||
| Disposition | |||||||||||||||||||||||||||||||
| Email Disposition | Type: DispositionType, Default: NoChange
Disposition of items after successful import. Can be one of the following values:
|
||||||||||||||||||||||||||||||
| Flag Emails as Read | Type: Boolean, Default: True
If true, then emails will be flagged as Read after importing. |
||||||||||||||||||||||||||||||
| Disposition Folder | Type: String
The folder path within a mailbox where messages should be moved after processing. |
||||||||||||||||||||||||||||||
| Processing Options | |||||||||||||||||||||||||||||||
| Sparse Import | Type: Boolean, Default: True
If true, documents will be imported in sparse mode. Sparse documents avoid duplicating storage in Grooper when the content can be accessed through a link. Sparse imports serve two general purposes:
|
||||||||||||||||||||||||||||||
| Skip Count | Type: Int32, Default: 0
Indicates the number of items to skip at the beginning of the sequence. Use this property to restart an import which was previously stopped. |
||||||||||||||||||||||||||||||
| Max Items | Type: Int32, Default: 0
Indicates the maximum number of items to process. This can be used with Skip Count to perform incremental imports. |
||||||||||||||||||||||||||||||
| Batch Creation | |||||||||||||||||||||||||||||||
| Starting Step | Type: Batch Process Step
The step within a batch process where batches will be started. |
||||||||||||||||||||||||||||||
| Folder Levels | Type: List of Folder Level Info
Defines the number of folder levels which will be translated into subfolders within the Grooper Batch. |
||||||||||||||||||||||||||||||
| Maximum Items per Batch | Type: Int32, Default: 2500
The maximum number of items to be imported into a single batch. |
||||||||||||||||||||||||||||||
| Priority | Type: Int32, Default: 3, Range: 1 - 5
The priority of the batch. The Priority value controls the order in which tasks are processed, with the value 1 representing the highest priority level, and the value 5 representing the lowest priority level. (i.e. Items of priority 1 are processed before items of Priority 2, and so on). The batch must be paused before this property can be edited. |
||||||||||||||||||||||||||||||
| Batch Name Prefix | Type: String
An optional prefix to be prepended onto each batch name. Example Given the date is 01-02-2019 and the time is 1:39:00 PM, entering "Tommy Oliver's AP batch_:_" will result in the batch being named: "Tommy Oliver's AP batch_:_ 2019-01-02 01:39:00 PM" |
||||||||||||||||||||||||||||||
| Start Paused | Type: Boolean, Default: True
If true, created batches will be started in a paused state. |
||||||||||||||||||||||||||||||
| Batch Folder Classification | |||||||||||||||||||||||||||||||
| Content Type | Type: Content Type
Optionally assign a content type to created batch folders. |
||||||||||||||||||||||||||||||
Batch Process Step, Content Type, Data Type, Folder Level Info