Skip to main content
Mitratech Success Center

TeamConnect IMAP Settings

TeamConnect IMAP Server

Note: IMAP settings pages are not visible to users who are running TeamConnect® Express

The TeamConnect IMAP Server allows users to synchronize folders and email (from an email client) with Project records in TeamConnect (such as, Disputes, Matters, or Transactions).

Perform the following to set up and start the TeamConnect IMAP Server:

  1. (optional) If you will require encrypted connections (SSL) to the TeamConnect IMAP Server, set up SSL for the IMAP Server.
  2. Enable IMAP search views for custom objects (from TeamConnect; for example, Disputes). For more information, see Enabling IMAP Search for Custom Object Search Views.
  3. Configure the IMAP Server (from TeamConnect).
  4. Start the IMAP Server (from TeamConnect).
  5. Verify user/group rights for email messages and folders (from TeamConnect).
  6. Configure users' email clients.

Setting Up SSL for the IMAP Server

The TeamConnect IMAP Server supports encrypted connections (SSL). If you will require encrypted IMAP connections (SSL) from IMAP Clients, the following are required:

Important: The JDK installation used for running the Keytool should be the same JDK installation used by the TeamConnect application server. For additional information about keystores, see your JDK vendor documentation.

  1. Get the Keytool security tool (provided in a JDK).

    Note: For remaining SSL setup requirements, high level descriptions are provided but you must refer to your JDK vendor's documentation for details.
     
  2. Using Keytool, do the following on the TeamConnect server:
    • Create a keystore (including a public/private key pair). Use the RSA algorithm.
      Note: You will need the keystore file location, keystore password, and key password to set up the TeamConnect IMAP Server.
    • Generate a Certificate Signing Request (CSR). Send a request for a signed certificate to a Certification Authority (CA), using the information in the CSR.
    • After you receive the resulting certificates from the CA, use Keytool to import the certificates to the keystore.

      Note: If you had generated a self-signed certificate above, you need to replace it by importing a signed certificate from the CA.

Important: The keystore used for IMAP over SSL must be generated by a Keytool from a JDK. Also it is recommended to generate a new CSR from the Keytool and order a new SSL certificate for the IMAP server.

Configuring the IMAP Server

You can change the IMAP Port number and set up the IMAP Server to start automatically when TeamConnect is restarted.

Tips and Warnings

  • If you have already started the IMAP Server, and you update the IMAP Port, you need to stop and start the IMAP Server before the new port number will take effect.
  • If you have already started the IMAP Server and you update the auto-start behavior of the IMAP Server, the changes take effect the next time you restart TeamConnect.
  • If you are unable to start the IMAP Server, there might be a port usage conflict. Another IMAP Server may be running on the application server. There may be permissions restrictions where the default port is reserved for system processes or use by privileged users. You may need to change the port number (for example, 49152 or greater).
  • If you have already started the IMAP Server, and you update settings related to SSL for IMAP Server, you need to stop and start the IMAP Server before changes will take effect.
  • The TeamConnect IMAP Server supports encrypted connections (SSL) and unencrypted connections simultaneously. If SSL is enabled from IMAP Server system settings, IMAP Clients can still use unencrypted connections using the IMAP Port number

To configure the IMAP Server

  1. Select the Admin tab.
  2. Click Admin Settings under the tab bar.
  3. Click the Email link in the left pane.
  4. Edit the fields based on descriptions in the TeamConnect IMAP Server Email Settings table.
  5. Click Update.
  6. Restart TeamConnect on the application server.

Team Connect IMAP Server Email Settings

Field

Description

Enable SSL

Indicates whether an encrypted IMAP connection is supported.

SSL Port

Enter the port number where you want IMAP server to listen for SSL connections. If you require IMAP Clients to connect to the IMAP Server using SSL, this value must match the IMAP Port specified on users' email client IMAP account. Also see the description for IMAP Port in this table.

KeyStore Location

The path to the keystore file (including the keystore file name). This location should be in the same machine that hosts TeamConnect. For example, /certs/ImapKeystore/imapkeystore.jks

KeyStore Password

The keystore password.

Key Password

Password for the generated private key, which you used to obtain the certificate.

IMAP Port

Enter the IMAP port number (for non-SSL connections). This port must match the IMAP Port specified on users' email client IMAP account. The default value is 143.

Note: Even if you select the Enable SSL check-box, you can still set the IMAP Port and IMAP clients can connect to the IMAP Server using non-SSL connections. Also see the description for SSL Port in this table.

Status

(Read-only) Indicates whether the TeamConnect IMAP Server is Started or Stopped.

Run on Startup

Indicates whether the TeamConnect IMAP Server will be automatically started when TeamConnect is started (or restarted). If this check-box is cleared, you would need to manually start the TeamConnect IMAP Server after TeamConnect is started.

Starting and Stopping the IMAP Server

By default, the IMAP Server is disabled. You must manually start the IMAP Server the first time.

Tips and Warnings

  • If you restart the IMAP Server while users have IMAP Clients open, the users will need to close and reopen their IMAP Clients.
  • You can start the IMAP Server from the Admin Settings without restarting the TeamConnect server.
  • The Start button is available only if the IMAP Server status is Stopped.
  • The Stop button is available only if the IMAP Server status is Started.

To start and stop the IMAP Server

  1. Select the Admin tab.
  2. Click Admin Settings under the tab bar.
  3. Click the Email link in the left pane.
  4. Do one of the following:
    • To start the IMAP Server, click Start.
    • To stop the IMAP Server, click Stop.
  5. Click Update.

Email Rights

Some prerequisite rights for working with email and email folders need to be set up from the Admin area of TeamConnect in user or group rights. There are additional email record and email folder-level rights that can be managed from the user area of TeamConnect.

For details, see Rights for End-users.

Email Clients

See the Release Notes for specific client versions supported.

  • Was this article helpful?