Configuring the Email Listener

The Email Listener monitors a configured email account for replies to notifications. You must configure it for your implementation.

The initial reply to a notification creates a discussion and subscribes all recipients of that notification to the New Reply event for the discussion. Subsequent replies to the email thread are added to the discussion and emailed to the subscribed users. This scheme means that users can participate in a discussion initiated by a notification without needing to log into the apps.

  1. In your email system, create an account for user "Subscription Agent".
  2. Open the Run MQL window:
    1. From the compass, select Collaboration and Approvals.
    2. In the navigation pane, click Utilities > Run MQL.
    To run an MQL command, enter the command in the MQL Command box and click Run or press Enter.
  3. To set the context for the MQL session, run this command:

    set context user creator;

  4. Define the email address for the Subscription Agent person:
    1. To find the current email address of the Subscription Agent person run this command: 

      print person "Subscription Agent";

      The details include the current email address.

    2. To update the email address to the one you created in step 1, run this command: 

      modify person "Subscription Agent" email <EMAIL ADDRSS> enable email disable iconmail;

      where <EMAIL ADDRSS> is the address defined in step 1.

  5. Enter values for these elements in the mailListener.xml file, located in the INSTALL/conf directory:

    Elements Description
    mailBox protocol The protocol used by your mail server; must be POP or IMAP.
    user Email account to be monitored for incoming email. The person "Subscription Agent" is created and installed for this purpose.

    If the user name for a POP or IMAP account requires a domain identifier, such as username@company.com, replace the @ symbol with the hexadecimal value for the + symbol (%2B). If you use the + symbol itself, encoding rules change it to a space when sent to the mail server, so make sure you use the hexadecimal value, %2B, such as username%2Bcompany.com.
    password The email account password for the above user.
    mailHost The internet address of the host for the email server.
    interval Time between polling for incoming messages, in milliseconds.
    jpo Name of the JPO to execute when email is found in the polled account. Unless you create a custom JPO:method, you should not change this value.
    matrixUrl The URL of the server.

    This code shows the config.xml file as installed:

    <?xml version="1.0" encoding="utf-8"?>
<matrixMailListener>
  <mailBox protocol=POP>
    <!-- Mail box parameters -->
    <user>Subscription.Agent</user>
    <password>MailBoxPassword</password>
    <mailHost>MailHost</mailHost>
    <interval>PollingInterval</interval>
    <jpo> emxSubscriptionReplyHandler  -method captureMailInfo</jpo>
    <MatrixUrl>Matrix Server Url</MatrixUrl>   
   </mailBox>
  <mailBox protocol=IMAP>
    <!-- Mail box parameters -->
    <user>Subscription.Agent</user>
    <password>MailBoxPassword</password>
    <mailHost>MailHost</mailHost>
    <interval>PollingInterval</interval>
    <jpo> emxSubscriptionReplyHandler  -method captureMailInfo</jpo>
    <MatrixUrl>MatrixUrl</MatrixUrl> 
   </mailBox> 
</matrixMailListener>

  6. Start the email listener daemon:

    On UNIX: execute mailListener.sh in the INSTALL/scripts directory.

    On Windows: execute mailListener.bat in the INSTALL/bin/winnt directory.