How To Enable the Email Agent to Operate with an SSL Enabled Mail Server

Note: This applies to DocuShare 6.5.x, 6.6.x, and 7.

The information provided in this solution provides the process required to implement IMAP with SSL for Email Agent. All steps provided in the solution must be completed to properly configure the Email Agent to operate with an SSL-Enabled Mail Server.

Note:  You must be a Windows Administrator to perform this solution.

Prerequisites:

•      The installation of an SSL certificate in DocuShare must be completed. 

Note: For complete instructions, see related solution LDAP and SSL link listed at the bottom of this page. (importing the SSL certificate is the same process used for SSL LDAP connections)

Solution

1.   Modify the Monitor.xml to add the mail agent services runtime switch to point to the dstruststore.

a.   Open Windows Explore and browse to the <dshome>\docushare\config directory.

Where <dshome> is replaced with the installation directory for DocuShare. The default installation path is C:\Xeorx\Docushare. Depending on your installation environment the path may vary.

b.   Make a copy of the Monitor.xml file and rename the copy to Monitor.xml.orig.

c.   Open the Monitor.xml file in a text editor such as Notepad.

d.   Add the mailagent service’s runtime switch to point to the dstruststore.

Note: The jdk path is different for DocuShare DS 6.6.x and DS 7.

For DS 6.6.x

-Djavax.net.ssl.trustStore=+DSH+\jdk1.6.0\jre\lib\security\dstruststore

For DS 7

-Djavax.net.ssl.trustStore=+DSH+\jdk\jre\lib\security\dstruststore

Example of a DocuShare 6.6.x server with entry added (see the text in red below).

Note:  Before making any changes to the Monitor.xml, make a backup copy and name it Monitor.xml.orig.

  <Server>

    <Name>mailagent</Name>

    <MonitorStart>true</MonitorStart>

    <MonitorStop>true</MonitorStop>

    <MonitorControl>true</MonitorControl>

    <MonitorStatus>true</MonitorStatus>

    <CanRestart>true</CanRestart>

    <CanReload>true</CanReload>

    <MustExist>false</MustExist>

    <RMIMaxRetry>5</RMIMaxRetry>

    <BeforeStartWait>3000</BeforeStartWait>

    <StartWait>3000</StartWait>

    <AfterStartWait>3000</AfterStartWait>

    <NeedPolicy>true</NeedPolicy>

    <NeedsCredential>true</NeedsCredential>

    <ServerType>java</ServerType>

    <JavaServer>

      <JavaServerParam>

        <Platform>all</Platform>

        <StartClassName>com.xerox.docushare.mailagent.MailagentSVC</StartClassName>

        <StartJVMClassPath>+DSH+\lib\mailagent.jar;+DSH+\lib\bcmail.jar;+DSH+\lib\bcprov.jar;+DSH+\lib\docushare3.jar;+DSH+\lib\log4j.jar;+DSH+\lib\xalan.jar;+DSH+\lib\jdom.jar;+DSH+\lib\xercesImpl.jar;+DSH+\lib\xml-apis.jar;+DSH+\lib\activation.jar;+DSH+\lib\j2ee.jar;+DSH+\lib\mailapi.jar;+DSH+\lib\dsn.jar;+DSH+\lib\smtp.jar;+DSH+\lib\pop3.jar;+DSH+\lib\imap.jar;+DSH+\lib\amber.jar;+DSH+\lib\dscommon.jar;</StartJVMClassPath>

        <StartJVMParams>-Dcom.xerox.docushare.install=+DSH+ -Djavax.net.ssl.trustStore=+DSH+\jdk1.6.0\jre\lib\security\dstruststore -Dcom.xerox.docushare.jmslogprint=enabled -Ddocushare.mailagent.standalone=yes -Xrs</StartJVMParams>

        <StartAppParams></StartAppParams>

      </JavaServerParam>

    </JavaServer>

  </Server>

2.   Enable the Email Agent to operate with an SSL enabled mail server, by manually editing the mailagent.properties file.

a.   To manually edit the mailagent.properties file.

1)   Open Windows Explorer.

2)   Browse to the Xerox\Docushare\config directory.

3)   Make a copy of  the mailagent.properties file and rename the copy mailagent.properties.orig.

4)   Open the mailagent.properties file in a text editor such as Notepad.

5)   Search for the imapMailboxPort= entry and edit it to match your servers IMAP or POP3 mailbox port number.

Example: imapMailboxPort=993 or imapMailboxPort=995Search for the isSSL= entry and change the value to true. 

For example, isSSL=true. Example:  isSSL=true

6)   Save the changes in the file.

7)   Restart DocuShare.

b.   Configure the Email Agent in DocuShare.

Note: For detailed instructions see related solution How To Set Up the Email Agent link listed at the bottom of this page.

Note: If the LDAP email addresses are mixed case after they added to DocuShare then the emails sent to DocuShare via the Email Agent show up in Default Collection. To resolve this issue see related solution Emails Sent to DocuShare via the Email Agent Show up in Default Collection link listed at the bottom of this page

Solution Updated: April 17, 2017

Solution ID: 518