Homepage Installation Administrator Tips Developer Tips Download Buy

1. Prerequisites

2. Installation

The download package consists of

  1. Download and unzip the installation package.
  2. Copy the Squirrel.jar file to the IBM Domino server directory domino/ndext. Under Linux/Unix/AIX, make sure that the JAR file has executable rights thru chmod +rx Squirrel.jar.
  3. Copy the database template Squirrel.ntf to the root data directory of the IBM Domino server.
  4. Sign the database template Squirrel.ntf with the Server-ID.
  5. Create a new database with the name Squirrel.nsf in the root data directory from the template and set the ACL as needed.
  6. In the IBM Notes client, create the configurations, connections and mail account subscriptions documents.

If the RunJava task is already running on the server, it may be necessary to restart the RunJava task to restart its JVM to find the newly installed Squirrel.jar container.

Database Access Control Lists

Please make sure that the Roles are correctly set in the Database Access Control (ACL) list. They are important in controlling, who is able to create the different types of documents.

ACL Entry Roles
Users EditAcc
Administrators EditConfigSrv, EditConn
Servers EditConfigSrv, EditConn, EditAcc, ReadAllAcc

3. Start application

There are several ways to start the application.

Console Command

Enter the command Load RunJava JAddin Squirrel in the IBM Domino console:

Load RunJava JAddin Squirrel
08.02.2019 14:06:50   Squirrel: The Internet Mail Collector for IBM Domino - Version 1.0.0 2019-02-10
08.02.2019 14:06:50   Squirrel: Copyright iota systems GmbH 2019 / ABdata, Andy Brunner 2019. All Rights Reserved.
08.02.2019 14:06:50   Squirrel: License key valid for 50 mail account subscriptions until 2019-09-04
08.02.2019 14:06:52   Squirrel: IMAPS message forwarded to John Smith/ACME from somebody@outlook.com (Size 689 KB)
08.02.2019 14:06:52   Squirrel: POP3S message forwarded to Jim Chu/ACME from another.user@gmail.com (Size 286 KB)

Notes.ini

You may change the line starting with ServerTasks= to include the task to be started, e.g.

ServerTasks=Replica,Router,Update,RunJava JAddin Squirrel,AMgr,...

Program Document

The easiest and recommended way is to add a program document in the IBM Domino directory.

Program Document

4. Configuration Database

The IBM Domino database Squirrel.nsf contains configuration and status information. The three types of documents defines the IBM Domino server environment, the connections to the Internet mail servers and the mail account subscriptions for the mail retrieval.

Squirrel Configuration Document

This document defines the Squirrel program running on the server.

Field Value Description
Domino Server Name Name Domino server name on which the Squirrel Add-in is running, e.g. “Server/ACME”
Interval (3-240 minutes) Number Number of minutes to wait between mail retrievals, e.g. 15
Send sys msg to Name Fill in the mail address, where Squirrell shall send systems and error messages to
License Key String Squirrel license key for this server or empty for test mode
Status Active, Inactive Set to “Inactive” to disable the Squirrel processing for this server

Internet Host Connection Document

This document defines the Internet mail servers to be used.

Field Value Description
Connection Name String Descriptive name of the connection, e.g. “Google Mail Switzerland (gmail.ch)”
Domino Server Name Domino server name for which this configuration is active
Internet Host Name String Internet host name or IP address of the internet mail server, e.g. “imap.gmail.com”
Connection Protocol IMAPS, IMAP, POP3S, POP3 Protocol to access the internet mail server
Internet Host Port Number TCP/IP port number of the internet mail server, e.g. 993
Status Active, Inactive Set to “Inactive” to disable the connection

Mail Account Subscription Document

This document defines the mailboxes on the Internet mail server.

Field Value Description
Notes User Name Name Hierarchical user name, e.g. “John Smith/ACME”
Domino Server Name Server name for which this account is active
Connection String Used connection (see Internet host connection documents)
Internet Mail User Name String Account user name on the Internet mail server, e.g. “jsmith@gmail.com”
Internet Mail Password String Account password on the Internet mail server, e.g. “password”. This field will be encrypted.
Keep Mails on Server Yes, No Specifies if the processed messages should be deleted on the Internet mail server
Subscription Status Active, Inactive Set to “Inactive” to disable the account
Comment String Description of this account definition
Last Error Message String Last error message set by Squirrel, e.g. “Invalid user password”

5. Common Error Messages

Error Message Possible Reason
RunJava: Can't find class JAddIn or lotus/notes/addins/jaddin/Squirrel in the classpath. Class names are case-sensitive. The RunJava task was unable to load the class. Make sure that it is written with exact upper and lower case characters and it can be found by the RunJava class loader.
JAddin: Unable to load Java class Squirrel The JAddin framework was unable to load Squirrel.jar. Make sure that it is written with exact upper and lower case characters.
RunJava: Can't find stopAddin method for class Squirrel.  The Squirrel class must be loaded thru the JAddin framework and not directly from RunJava. Use the command Load RunJava JAddin Squirrel to start the user class.
RunJava JVM: java.lang.NoClassDefFoundError: Squirrel (wrong name: SQuirrel) The user class name in the command and the internal name do not match. Most likely you have not typed the name with correct upper and lower case characters.
Out of memory All Java add-ins execute in a single Java Virtual Machine (JVM) in RunJava. The Domino Notes.Ini parameter JavaMaxHeapSize=xxxxMB may be used to increase the heap space.