The IMAP endpoint enables Automate MFT to connect to an email server and use email attachments as a source of files for task processing. IMAP endpoints can be used to download attachments from mail folders such as Inbox and other folders supported by the email server.

Unlike most endpoint types, IMAP endpoints can only be used as source endpoints. Email attachments are downloaded and processed as files, while email messages themselves remain on the mail server unless they are deleted through update original processing.

Important: IMAP endpoints can only be used as source endpoints in download steps. They cannot be used as destination endpoints. To send files as email attachments, use an SMTP endpoint.

Create an IMAP endpoint

To add a new IMAP endpoint:
  1. Click the Libraries drop-down menu and select Endpoints.
  2. Click the Add Endpoints drop-down menu and select IMAP.
  3. The New IMAP Endpoint dialog appears.

General

Enter basic endpoint details:
  • Name: Provide a unique name for the endpoint.
  • Description: Optionally, enter a description to help identify the purpose or scope of this endpoint.
  • Host/IP address: Enter the Host/IP address
  • Port: The port number is usually 993.
  • Authentication Method: Search for and select an authentication method from the authentication method library, or click Add New Authentication Method to create one without leaving the endpoint configuration screen. For more information, see IMAP authentication method.

Connection

Configure connection parameters:
  • SSL certificate errors: To ignore SSL certificate errors, select the check box.
    Note: Disabling SSL certificate validation may expose your connection to potential security risks. Only enable this option for trusted endpoints.
  • Use TLS: To enable Use TLS, select the check box.
  • Data Timeouts In Seconds: Enter the number of seconds to wait when sending data to or receiving data from the host. The default is 120 seconds.

Retry

Define retry behavior:
  • Retry Count: Number of extra times that a transfer is retried.
  • Retry Delay: The time between each retry.
  • Use the time unit drop-down menu to select a time measurement for the retry delay.

Save the endpoint

Click Save to create the endpoint

IMAP endpoint behavior

IMAP endpoints download email attachments only. The contents of email messages are not downloaded as files and cannot be transferred directly.

When a task runs, Automate MFT retrieves attachments from email messages in the selected mail folder and processes them as downloaded files. Standard source filtering options can be used to select which attachments are processed.

The Collect only files newer than the last successfully processed file option uses email message received date information to determine which attachments are newer than the last processed item.

Delete operations are supported. When an attachment is deleted, the email message containing the attachment is also deleted.

IMAP endpoint limitations

IMAP endpoints can only be used as source endpoints.

Attachments can be downloaded and processed, but email messages cannot be transferred as files.

Email messages cannot be moved between mail folders. Although some IMAP servers support message movement, this capability is not supported by Automate MFT.

Rename operations are not supported for IMAP attachments. If an Update Original step is configured to rename source files, the operation cannot be completed successfully for files originating from an IMAP endpoint.