IMAP

Defines a connection to an IMAP mail server.

Remarks

IMAPBinding provides a CMIS-compatible binding for connecting Grooper to IMAP-compliant mail servers.

---

Overview

• Enables Grooper to access, search, and manage email messages from one or more IMAP mailboxes.
• Connectivity is established using the IMAP protocol (RFC 3501), supporting most standards-compliant mail servers.
• Only mail messages are supported; calendar, contacts, and other object types are not accessible via IMAP.

---

Supported Content Types

Type	File Type / Extension	Description
Message	message/rfc822 (.eml)	Email messages only

• Only mail messages can be retrieved and exported.
• Attempting to access calendar events, contacts, or other special folders will result in an error.

---

Repository Mapping

• The login mailbox is exposed as a single repository by default.
• Additional mailboxes can be specified in the property (if supported by the server and account permissions).
• The property allows you to restrict which mailbox folders are exposed and searched.
  • If left empty, all folders are exposed.
  • Selecting specific folders can improve search performance and exclude unwanted folders (e.g., "Deleted Items", "Junk").

---

Authentication and Security

• Requires a valid username and password for the IMAP server.
• The property enables secure (encrypted) connections (recommended).
• The property should match your server's SSL/non-SSL configuration (default 993 for SSL, 143 for non-SSL).
• The user account must have access to all mailboxes specified in (if used).

---

Search and Query Capabilities

• Supports CMIS queries for mail messages, including property-based and full-text search.
• String comparisons are limited to substring (LIKE '%value%') searches.
• IMAP search does not support phrase searching, logical operators within a single predicate, or the IN() predicate.
• Only mail message content is indexed and searchable.
• Selecting fewer folders in can improve search speed.

---

Usage Notes

1. Configure Server and Credentials
   • Set , , , , and .
2. Select Folders (Optional)
   • Use to limit which mailbox folders are exposed and searched.
3. Specify Mailboxes (Optional)
   • Use to expose additional mailboxes as repositories (requires appropriate permissions and server support).
4. Import Repository
   • Use Grooper's CMIS Connection UI to import and manage the IMAP repository.

---

Limitations

• Only mail messages are supported; calendar, contacts, and other object types are not accessible.
• IMAP search is limited compared to Exchange/EWS (no phrase search, no IN(), limited operators).
• Some IMAP servers may not support multi-mailbox access or may have unique folder structures.
• No support for Exchange-specific features (use ExchangeBinding for full Exchange support).

---

References

• IMAP Protocol (RFC 3501)
• Grooper Documentation

---

> Note: This class is intended for use within Grooper's CMIS infrastructure and is not a general-purpose IMAP client.

Properties

Name	Type		Description
Mail Server	String	►	The host name or IP address of an IMAP mail server. Requiredtrue Example: imap.gmail.com, outlook.office365.com, or a local server IP. This must be accessible from the machine running Grooper. Contact your IT administrator or email provider for the correct value.
User Name	String	►	The user name to be used for accessing the Mail Server. Requiredtrue Typically the full email address (e.g., user@domain.com). Some servers require a domain prefix (e.g., domain\\username). The account must have permission to access all mailboxes specified in .
Password	String	►	The password to be used for accessing the Mail Server. Requiredtrue The password is stored encrypted. Required for most authenticated IMAP servers. Use an app password if your provider requires it (e.g., Gmail with 2FA).
Use SSL	Boolean	►	Controls whether the connection to the Mail Server will be established using SSL. DefaultTrue Enable for secure (encrypted) connections (recommended). Most modern IMAP servers require SSL/TLS. Set to false only if your server does not support SSL.
Port No	Int32	►	The port number on which the IMAP server is running. Requiredtrue Default993 Default: 993 (SSL enabled), 143 (SSL disabled). Check with your email provider or IT administrator for the correct port.
Folders	List(Of String)[]	►	An optional list of mailbox folders which should be exposed. Editorfolder Editor ConverterPg String Collection Converter Specify one or more folder names at the root of the mailbox to be exposed. If left empty, all folders will be exposed. Selecting specific folders can improve search performance and exclude unwanted folders (e.g., "Deleted Items", "Junk"). Only mail message content can be retrieved through IMAP. Other types (calendar, contacts) may appear but cannot be accessed. To access non-message objects, use the Exchange connection type.
Mailboxes	List(Of String)[]	►	An optional list of mailbox names to be exposed as repositories. EditorString List Editor ConverterPg String Collection Converter If left empty, a single repository is exposed for the login account. If values are provided, one repository is exposed for each mailbox. The user account must have permission to access all listed mailboxes. Not all IMAP servers support multi-mailbox access. Example: shared@domain.com, archive@domain.com

Used By

CMIS Connection