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

Mail Link

Document Link Grooper.Messaging

Represents a reference to an email on an IMAP mail server.

Remarks

The Mail Link class enables Batch Folder objects to reference and interact with email messages stored on IMAP mail servers. This is essential for scenarios where Grooper must ingest, process, or archive emails and their attachments as part of a document-centric workflow.

Mail Link objects are typically created when importing content from an IMAP server using Grooper's mail import features. Instead of copying the email directly into the repository, Grooper stores a link to the message, allowing content to be loaded on demand or referenced for audit and traceability purposes.

The class exposes connection and message identification properties such as 'Mail Server', 'User Name', 'Password', 'Use SSL', 'Port No', 'Mailbox Name', 'Folder Name', and 'Message ID'. These must be configured to establish a connection to the IMAP server and locate the desired email. These properties are typically set during import but can be edited to update connection details or message references.

Mail Link provides commands for loading the email content, expanding attachments, and deleting the message from the server. These commands support full lifecycle management of external email content from within Grooper, including content ingestion, attachment extraction, and cleanup.

Usage Guidance

  • Use Mail Link to reference and process emails stored on IMAP servers, enabling integration with enterprise mail systems.
  • Configure the connection and message identification properties to match your mail server's address, authentication, and mailbox structure.
  • Use the provided commands to load email content, extract attachments, or delete messages as part of your workflow.
  • Mail Link is essential for scenarios where emails and their attachments must be processed, archived, or integrated into document-centric business processes.

For more information, see the documentation for Batch Folder, Content Link, and mail import features.

Properties

NameTypeDescription
General
Mail Server Connection
Mail Item Info
Mail Link
ContentLink
Document Link

Context Menu Commands

Command Shortcut Description
mail Delete Message Delete the linked Mail server object from the mail server.
mail Expand Attachments Expands all attachments as children of the folder object.
mail Load Content Loads the content from the linked Mail server object and saves it as the local attachment on the associated Batch Folder.
Notification