2023:IMAP (CMIS Binding)

From Grooper Wiki

This article is about an older version of Grooper.

Information may be out of date and UI elements may have changed.

202520232.72

IMAP is a connection option for cloud CMIS Connections. It connects Grooper to email messages and folders through an IMAP email server for import and export operations.

The mail server must use the IMAP (Internet Message Access Protocol) protocol to retrieve messages.  However, virtually all email clients support IMAP, including Gmail, Outlook and Yahoo! Mail. Once connected, you can import, export, search, and browse inboxes from Grooper.

Messages will be imported as a .eml file.  Attachments can be extracted from the message using the "Expand Attachments" command.  This is accessible to a Batch Process by using the "Execute" activity.

FYI

If you use Microsoft Outlook, the Exchange binding has increased functionality for importing and exporting via email using Microsoft Exchange servers.  You'll want to use that one over the IMAP binding.

Glossary

Batch: inventory_2 Batch nodes are fundamental in Grooper's architecture. They are containers of documents that are moved through workflow mechanisms called settings Batch Processes. Documents and their pages are represented in Batches by a hierarchy of folder Batch Folders and contract Batch Pages.

CMIS Connection Type:

CMIS Connection: cloud CMIS Connections provide a standardized way of connecting to various content management systems (CMS). CMIS Connections allow Grooper to communicate with multiple external storage platforms, enabling access to documents and document metadata that reside outside of Grooper's immediate environment.

  • For those that support the CMIS standard, the CMIS Connection connects to the CMS using the CMIS standard.
  • For those that do not, the CMIS Connection normalizes connection and transfer protocol as if they were a CMIS platform.

CMIS Export: CMIS Export is an Export Definition available when configuring an Export Behavior. It exports content over a cloud CMIS Connection, allowing users to export documents and their metadata to various on-premise and cloud-based storage platforms.

CMIS Import: CMIS Import refers to two Import Providers used to import content from settings_system_daydream CMIS Repositories: Import Descendants and Import Query Results. CMIS Imports allow users to import from various on-premise and cloud based storage platforms (including Windows folders, Outlook inboxes, Box accounts, AppEnhancer applications and more).

CMIS: CMIS (Content Management Interoperability Services) is open standard allowing different content management systems to "interoperate", sharing files, folders and their metadata as well as programmatic control of the platform over the internet.

Exchange: Exchange is a connection option for cloud CMIS Connections. It connects Grooper to Microsoft Exchange email servers (including Outlook servers) for import and export operations.

Execute: tv_options_edit_channels Execute is an Activity that runs one or more specified object commands. This gives access to a variety of Grooper commands in a settings Batch Process for which there is no Activity, such as the "Sort Children" command for Batch Folders or the "Expand Attachments" command for email attachments.

Export: output Export is an Activity that transfers documents and extracted information to external file systems and content management systems, completing the data processing workflow.

IMAP: IMAP is a connection option for cloud CMIS Connections. It connects Grooper to email messages and folders through an IMAP email server for import and export operations.

Project: package_2 Projects are the primary containers for configuration nodes within Grooper. The Project is where various processing objects such as stacks Content Models, settings Batch Processes, profile objects are stored. This makes resources easier to manage, easier to save, and simplifies how node references are made in a Grooper Repository.

Repository: A "repository" is a general term in computer science referring to where files and/or data is stored and managed. In Grooper, the term "repository" may refer to:

Version Differences

Prior to version 2.72, connections to IMAP servers were made using the Mail Import and Mail Export providers. The IMAP binding replaces the old Mail Import provider. Mail Import is still available as a Legacy provider. While these providers still exists in Grooper as Legacy Import and Legacy Export providers, they are depreciated components and no longer recommended for use. For increased functionality in 2.72, create a CMIS Connection using IMAP Connection Type (or Exchange if connecting to an Outlook inbox) and utilize the new CMIS Import and CMIS Export capabilities.

How To: Create a New IMAP Connection

  1. Open your Projects folder. Right-click a Project, select "Add", then "CMIS Connection."

  1. Name your CMIS Connection, then click "Execute."

  1. Select IMAP from the Connection Settings drop-down menu.

Expand the "Connection Settings" heading. Enter the mail server and the user name and password to access that server.



Optionally, you can choose not to use SSL by turning that property to "False".

You can change the port number by editing the "Port No" property.

The "Folders" property allows you to choose which mailbox folders to expose. If nothing is selected, all will be visible.

Last, if you have permissions to access multiple mailboxes, you can list them using the Mailbox property. They will be exposed as individual repositories. If no mailboxes are listed, a single repository is exposed for the login email account.


  1. Press the "List Repositories" button to expose all possible email accounts
  2. Again, if nothing is entered in the "Mailboxes" property, only the login account will be visible.

  1. Ensure that the Repository displayed is the one you want, then click "Execute".

  1. Select the Import Repository button to bring in these repositories for Grooper to import and export to the corresponding file system.
  2. The False icon will turn to True once the repository is successfully imported.

Selecting the imported repository and switching the the Browse Repository tab, you can see all the folders within that mailbox you have access to. Note that only messages are visible using the IMAP connection. If you are connecting to an Exchange server, the Exchange binding can also access calendar, contact and task objects.