Squalit: call popups for Thunderbird & Asterisk

Contents

Links

Introduction

Squalit is a companion application for the callPopPy incoming call popup notifier for Asterisk. Squalit is a Thunderbird extension which populates callPopPy's database with data from your Thunderbird addressbook. By using the two together you get call notification popups from your Asterisk server that include the display name of the caller as stored in your Thunderbird addressbook.

When callPopPy and Squalit are combined with the TBDialOut click2dial extension for Thunderbird you have excellent integration of your Thunderbird address book with your Asterisk phone system.

Installation

You can grab the latest release of Squalit, currently version 0.2.3, or checkout the current development source on github. Once you have the .xpi file, install it as you would any Thunderbird extension.

Save the .xpi file to your computer. Then select Tools > Add ons. In older versions of Thunderbird, click the "Install..." button. In more recent versions, select 'Install addon from file...' from the tools dropdown button. Select the file and follow the onscreen directions.

Configuration

Squalit is configured by selecting Tools > Configure callPopPy exports, or from the Addons manager.

Address book(s) for auto export

Squalit can periodically update the callPopPy database by exporting contacts from configured address books. Check the address books that you want to be included in auto exports. Note you can always manually export other address books by right clicking on them in the address book list.

Screen shot of Squalits preferences dialogue

Update interval

If you want to update the callPopPy database periodically, set the interval between updates in minutes. Setting this value to 0 disables periodic updates.

Replace leading '+'

If you have numbers in your address book stored with a leading "+" you may wish to replace this. Enter the replacement characters. The default is "00". Note that if you leave this field blank then the leading "+" will be replaced with an empty string, ie stripped. If you wish to keep the leading "+", enter "+" here.

Format for exported names

Configure how you wish the exported names to be formated. %N% will be replaced by the display name for the contact. You can configure different formats for different types of phone numbers.

For example, if you configure the work phone number as

%N% (w)

Then a contact with the display name "John Smith" will have the name associated with their work phone number exported as "John Smith (w)", and this is what callPopPy will display when a call is received from that number.

Advanced options

Several additional options can be set using Thunderbird's config editor. Go to Edit > Preferences or Tools > Preferences (depending on your operating system). Select 'Advanced' and in the General tab click on 'Config Editor...'.

extensions.squalit.loglevel

Controls the level of logging to the Error Console. Increase to 5 for debugging.

extensions.squalit.dbfile

Controls the location of the callPopPy database file. Note the format of this value is a "nsIRelativeFilePref" value. Refer to the Mozilla documentation for furter information.

Using Squalit

Auto update

The easiest way to use Squalit is to configure it to carry out periodic updates of callPopPy's database. You can also manually run an export from the address books configured for auto update by selecting Tools > Run callPopPy auto export.

Context menu

From Thunderbird's address book, you can right click on any address book in the address book list and export that address book.

From the list of contacts you can select one or more contacts, right click and export those contacts. This is useful if you have just added a contact and want to make sure it is exported to callPopPy as soon as possible.

Resetting the database

The option Tools > Reset callPopPy database will remove all entries from callPopPy's database and then run an auto export.

This is useful occasionally when contacts have changed their phone numbers. Because of the way that Squalit exports numbers, the new number will be saved to the callPopPy database, but the old one is not removed. Over time these old numbers can come to clutter up the database.

Database

By default, Squalit exports contacts to callPopPy's default database file location:

<homedirectory>/.callpoppy/callpoppy.db

Numbers have all spaces, punctuation and non-numeric characters stripped. Any leading "+" is replaced with the configured value. Separate records are created for each of a contact's phone numbers (home, work and mobile/cell). You can find more information on the database format here.

Early adopters should note that the export format changed in version 0.2.0. Prior to that only the last 10 digits were exported. Squalit now exports the entire number because as of the release of callPopPy 0.1.0 fuzzier matching was implemented that allows this. Squalit 0.2.0 and above is not compatible with pre-release versions of callPopPy, ie callPopPy 0.1.0pre*, which required numbers in the database to be truncated to the last 10 digits.

Screenshot

Squalit screenshot Exporting a contact from the context menu (right click menu).

Licence

As it is an extension to a Mozilla product, Squalit is released under the Mozilla Public License version 1.1