{"id":31753,"date":"2016-08-12T07:39:38","date_gmt":"2016-08-12T15:39:38","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/2019-1-2\/import-ingestion\/e-mail-configuration-4050\/email-import-configurations\/"},"modified":"2022-11-28T14:49:33","modified_gmt":"2022-11-28T21:49:33","slug":"email-import-configurations","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/import-ingestion\/email-configuration\/email-import-configurations\/","title":{"rendered":"Email Configuration"},"content":{"rendered":"

The purpose of the Email Configuration screen is to allow users to configure their email accounts with Ephesoft Transact. This screen works with the Email Import plugin to import documents from a user\u2019s email account. This configuration is done per batch class. Multiple email accounts can be set up for each batch class.<\/p>\n

<\/a>Prerequisites<\/h2>\n

Complete the following steps in order to turn on the email processing feature in Ephesoft Transact.<\/p>\n

    \n
  1. Open the applicationContext.xml<\/strong> file, located at <Ephesoft_Directory>\\Application\\applicationContext.xml<\/li>\n
  2. Locate and uncomment the following line to allow email processing. This line is commented out by default.<\/li>\n<\/ol>\n
    <import resource=\"classpath:\/META-INF\/applicationContext-dcma-mail-import.xml\" \/><\/pre>\n

    \nFigure 1. Default Lines in applicationContext.xml File<\/em><\/p>\n
      \n
    1. Restart Ephesoft Transact to apply the configuration update.<\/li>\n<\/ol>\n
      You have enabled the email processing feature. Continue to Configuration Steps<\/a> to connect your email account with Ephesoft Transact.<\/p>\n
      <\/a>Email Configuration<\/h2>\n
      Perform the following steps to configure email accounts:<\/p>\n
        \n
      1. Go to the Batch Class Management <\/strong>screen.<\/li>\n
      2. Open your batch class.<\/li>\n
      3. Click Email Configuration <\/strong>to begin defining user email accounts to be accessed by Ephesoft Transact.<\/li>\n<\/ol>\n

        \nFigure 2. <\/em>Email Configuration <\/em><\/strong>Screen<\/em><\/p>\n
          \n
        1. Use the following table as a guide to configure Transact to connect to your email account.<\/li>\n<\/ol>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
          Configurable Property<\/th>\nValue Type<\/th>\nValue Options<\/th>\nDescription<\/th>\n<\/tr>\n
          Username<\/th>\nString<\/th>\nValid email account username<\/th>\nThe account name to be connected to Ephesoft Transact<\/th>\n<\/tr>\n
          Password<\/th>\nString<\/th>\nCorresponding password for the configured username<\/th>\n\n
          Password for the configured user account<\/p>\n
          Note: Password will always visible as 8 * in the Password field.<\/p>\n<\/th>\n<\/tr>\n
          Incoming Server<\/th>\nString<\/th>\nValid mail server name<\/th>\nThe type of the mail server that the configured user account belongs to.<\/th>\n<\/tr>\n
          Protocol or Server Type<\/th>\nDrop-down selection<\/th>\nValid mail server type<\/p>\n
            \n
          • IMAP<\/li>\n
          • POP3<\/li>\n
          • Exchange<\/li>\n
          • OAuth2*<\/li>\n<\/ul>\n<\/th>\n
          		The type of the mail server that the configured user account belongs to<\/th>\n<\/tr>\n
          Folder<\/th>\nString<\/th>\nValid and existing mail folder name<\/th>\nThe name of the mail folder that the email import will be checking. This folder name can be \u201cInbox.\u201d<\/th>\n<\/tr>\n
          Security Type<\/th>\nDrop-down selection<\/th>\n\n
            \n
          • PLAINTEXT<\/li>\n
          • SECURED<\/li>\n
          • STARTTLS<\/li>\n<\/ul>\n<\/th>\n
          		The property that defines the security type used to connect to a mail server.<\/th>\n<\/tr>\n
          Port<\/th>\nInteger<\/th>\nValid port number<\/th>\nThe port number on which the configured mail server type will work.<\/p>\n
          This number will be determined by your email system.<\/th>\n<\/tr>\n
          Client ID*<\/th>\nString<\/th>\nValid client ID from Azure Active Directory<\/th>\n\n
          The client ID used for Office365 authentication with OAuth2.<\/p>\n
          Refer to Configuring Microsoft Email Services with OAuth2<\/a> for steps to obtain the client ID.<\/p>\n<\/th>\n<\/tr>\n
          Client Secret*<\/th>\nString<\/th>\nValid client secret from Azure Active Directory<\/th>\n\n
          The client secret used for Office365 authentication with OAuth2.<\/p>\n
          Refer to Configuring Microsoft Email Services with OAuth2<\/a> for steps to obtain the client secret.<\/p>\n<\/th>\n<\/tr>\n
          Enable<\/th>\nCheckbox<\/th>\n\n
            \n
          • Checked<\/li>\n
          • Unchecked<\/li>\n<\/ul>\n<\/th>\n
          		The property that defines whether email ingestion is active for this email address.<\/th>\n<\/tr>\n<\/thead>\n<\/table>\n
          *<\/sup><\/em><\/strong>Available for 2020.1.02 or above. This security type is only for the Exchange Online service offered through Office 365 or Microsoft 365 subscription plans. <\/sup><\/em><\/p>\n
            \n
          1. Click Test Email <\/strong>to verify if the configured user email account is valid.<\/li>\n
          2. Once the configuration is verified, click Deploy<\/strong> to enable automatic email ingestion for the batch class according to the cron schedule.<\/li>\n<\/ol>\n
            You have successfully configured Transact to work with your email account.<\/p>\n
            <\/a>Property Files Configuration<\/h2>\n
            For further email import configuration, refer to the following properties files:<\/p>\n