Capevace / email-tracker

Create trackers that tell you when emails were opened by embedding hidden images

email-tracker

Create trackers that tell you when emails were opened by embedding hidden images

Usage

Using with Docker

You can download the container from docker (armv7 only).

docker pull capevace/email-tracker

You can also build your own docker image by cloning the repo and then building it.

git clone https://github.com/capevace/email-tracker
cd email-tracker
docker build . -t capevace/email-tracker

Using with npm

You can download the package from npm.

npm i -g email-tracker

Environment Variables

• PORT (Number): set the port for the HTTP server

  Example:

  PORT=3000 email-tracker

• DB_PATH (String): set the DB path

  Example:

  DB_PATH=../data/emails.db email-tracker

Screenshots

Changelog

2.0.1

• 🩺 Removed documentation images from NPM release (20MB+ -> 17kb package size)

2.0.0

• ➕ Added header tracking

  When the hidden image is loaded, header information sent along with the request will be saved in the database. This is useful to determine if the tracker was invoked not by a genuine open, but by a proxy caching email resources beforehand (GMail does this for example).

• 🩺 Fixed mobile layout issues

Migration notice

If you've previously used v1.0.0, you'll need to run the following SQL on your SQLite .db, in order to make it compatible with v2.0.0:

ALTER TABLE events
  ADD headers TEXT;

1.0.0

• 🚀 Initial release