|Homepage||Installation||Administrator Tips||Developer Tips||Download||Buy|
- HCL Domino 9.0.1 FP8 or higher (requires Java Virtual Machine 1.8+)
- Direct access to the Internet mail server(s) from the HCL Domino server running the add-in
- Root and possible intermediate certificates from the Internet mail server(s) must be included in the CACert keystore file of HCL Domino (see Administrator Tips)
2. Installation / Upgrade
The download package consists of
- Squirrel.jar (HCL Domino add-in)
- Squirrel.ntf (HCL Notes database template)
2.1 Copy the distribution files
- Download and unzip the installation package.
- Copy the
Squirrel.jarfile to the HCL Domino server directory
domino/ndext. Under Linux/Unix/AIX, make sure that the JAR file has executable rights thru
chmod +rx Squirrel.jar.
- Copy the database template
Squirrel.ntfto the root data directory of the HCL Domino server.
- Sign the database template
Squirrel.ntfwith the Server-ID.
2.2 First time installation
- Create a new database with the name
Squirrel.nsfin the root data directory from the template and set the ACL as follows.
|Servers||EditConfigSrv, EditConn, EditAcc, ReadAllAcc|
- In the HCL Notes client, create the configurations, connections and mail account subscriptions documents.
2.3 Upgrade from previous installation
- Replace the database design with the signed new template.
- Edit, verify and re-save the configuration, connection and account subscription documents.
- If you plan to process all folders from the IMAP host, check the section on the Developer Tips on how to move the messages to the corresponding folders after processing.
- If the RunJava task is already running on the server, it may be necessary to restart the RunJava task to load the newly installed Squirrel.jar container.
3. Start application
There are several ways to start the application. Please note that the Java class names
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.
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)
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.
|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.
|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.
|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. “firstname.lastname@example.org”|
|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|
||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.|
||The JAddin framework was unable to load Squirrel.jar. Make sure that it is written with exact upper and lower case characters.|
|| The Squirrel class must be loaded thru the JAddin framework and not directly from RunJava. Use the command
||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.|
||All Java add-ins execute in a single Java Virtual Machine (JVM) in RunJava. The Domino Notes.Ini parameter