IMAP Connector 25.1
IMAP Connector Help

# Retrieve Data through IMAP

To automatically retrieve content from an IMAP server, create a new fetch task by following these steps. The connector runs each fetch task automatically, based on the schedule that is defined in the configuration file.

To create a new Fetch Task

1. Stop the connector.
2. Open the configuration file in a text editor.

3. In the `[FetchTasks]` section of the configuration file, specify the number of fetch tasks using the `Number` parameter. If you are configuring the first fetch task, type `Number=1`. If one or more fetch tasks have already been configured, increase the value of the `Number` parameter by one (1). Below the `Number` parameter, specify the names of the fetch tasks, starting from zero (0). For example:

       [FetchTasks]
       Number=1
       0=MyTask

4. Below the `[FetchTasks]` section, create a new TaskName section. The name of the section must match the name of the new fetch task. For example:

       [FetchTasks]
       Number=1
       0=MyTask

       [MyTask]

1. In the new section, specify the host name or IP address of the IMAP server, and the user name and password to use to authenticate.

   `ImapServerName` | The host name or IP address of the IMAP server.
   `UserName` | The user name required to access the IMAP server.
   `UserPassword` | The password required to access the IMAP server.

2. Specify the settings required to connect to the IMAP server:

   - To connect to the IMAP server over SSL, set the following parameters:

     `SSLConfigSection` | The name of a section in the configuration file that contains the settings required to communicate with the IMAP server over SSL.
     `ImapServerSSLPort` | The port to use for the SSL connection.

   - To connect to the IMAP server without SSL, set the following parameters:

     `ImapServerTCPPort` | The port to use to connect to the IMAP Server.

3. You can set additional parameters to specify how the connector retrieves information.

   `UseListCmd` | A Boolean that specifies the method used to retrieve a list of mailboxes. To use the RFC2060 LIST command to retrieve a list of mailboxes, set this parameter to `true`. To use the mailbox name specified by the `MailboxName` parameter, set this parameter to `false`.
   `MailboxName` | The name of the mailbox to retrieve messages from (when `UseListCmd=false`).
   `ListCmdMailboxName` | The wildcard sent to the IMAP server with the LIST command (when `UseListCmd=true`). Set this parameter to `*` to return everything, or set this parameter to an IMAP mailbox name to return a single mailbox.

   For a complete list of parameters that you can use to configure the IMAP Connector, refer to the IMAP Connector Reference.

4. Save and close the configuration file.

Copyright 2024 Open Text
Version 25.1 | Last updated January 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery IMAP Connector 25.1

Topic Title: Retrieve Data through IMAP