Homepage Installation Administrator Tips Developer Tips Download Buy


1. Prerequisites

2. Installation / Upgrade

The download package consists of

2.1 Copy the distribution files

2.2 First time installation

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

2.3 Upgrade from previous installation


3. Start application

There are several ways to start the application. Please note that the Java class names JAddin and Squirrel are both case sensitive and must be coded with exact case during startup.

3.1 Program Document

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

Program Document

3.2 Console Command

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

> Load RunJava JAddin Squirrel
17.10.2020 15:07:24   JVM: Java Virtual Machine initialized.
17.10.2020 15:07:24   RunJava: Started JAddin Java task.
17.10.2020 15:07:24   Squirrel: The Internet Mail Collector for HCL Domino - Version 1.4.1 2020-10-18
17.10.2020 15:07:24   Squirrel: Copyright iota systems GmbH / ABdata, Andy Brunner - All Rights Reserved
17.10.2020 15:07:25   Squirrel: License key valid for 10 mail account subscriptions until 2021-12-31
17.10.2020 15:07:26   Squirrel: IMAPS message forwarded to XXX/XXX from XXX@XXX.XXX (Size 689 KB)
17.10.2020 15:07:26   Squirrel: POP3S message forwarded to XXX/XXX from XXX@XXX.XXX (Size 286 KB)

3.3 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,...

4. Configuration Database

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

4.1 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 will 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

4.2 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

4.3 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”), group name or mail-in database name
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 after processing
Process Folders Inbox, All folders Specifies the folders to be processed (IMAP/IMAPS only)
Migration Flag This check-box will force the processing of all messages. It will be reset by the back-end after the first cycle.
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.