igloo-be / nodemailer-mail-tracking

Tracking mail opening and clicks on links

Nodemailer Mail tracking

Install

npm install nodemailer-mail-tracking

yarn add nodemailer-mail-tracking

Usage

import { sendMail, expressApp } from "nodemailer-mail-tracking"
import { createTransport } from 'nodemailer';
import express from 'express';

const transporter = createTransport(/* ... */);
sendMail(mailTrackingOptions, transporter, sendMailOptions)


const app = express();
app.use('/mail-track', expressApp(mailTrackingOptions));

Options

const mailTrackOptions = {
  baseUrl: 'http://localhost:3000/mail-track',
  jwtSecret: 'secret',
  getData: data => {
    /* 
      Default data: { recipient: "[email protected]" }
      Add any data if you want
    */
    return { ...data, hello: 'world' };
  },
  onBlankImageView: data => {
    /* 
      When email is opened 
      data is default data + your data
    */
  },
  onLinkClick: data => {
    /* 
      When click on link in mail 
      data is default data + { link } + your data
    */
  },
}

nodemailer-mail-tracking's Issues

does this work for tracking if the recipient uses gmail?

Track multiple recipients email open

I just wanted to know if I have 2 recipients in TO field and 1 in CC field. Would this be able to tell which recipient opened the email.

On Link Click

Could you please give an example of the setup required when using the onLinkClick to apply a callback once a link on the mail is pressed ?
What I would like to do is update my database whenever a link is clicked on the sent email, yet I have been struggling to do so.

onBlankImageView not working

onLinkClick works but onBlankImageView not working please help

const mailTrackingOptions = {
baseUrl: 'http://localhost:81/api/tracking/mail-track',
jwtSecret: 'secret',
getData: data => {
/*
Default data: { recipient: "[email protected]" }
Add any data if you want
/
console.log("data", data)
return { ...data, hello: 'world' };
},
onBlankImageView: data => {
/
When email is opened
data is default data + your data
*/
console.log("onBlankImageView", data)

},
onLinkClick: data => {
    console.log("onLinkClick", data)
    /*
      When click on link in mail
      data is default data + { link } + your data
    */
},

}
app.use('/mail-track', mailTracking.expressApp(mailTrackingOptions));

open email issue

on email open tacking is wokring , but it not returning blank image

Email open tracking is currently not functioning as expected for certain email providers.

Example
When sending emails to Gmail clients, the images do not load, and the system registers an "opened" event even when the user is in the inbox screen and has not yet opened the email.

Expected Behavior
The email open tracking should accurately detect when an email is opened, and the image rendering should work seamlessly across various email providers.

Steps to Reproduce

1. Send an email to a Gmail account with email open tracking enabled.
2. Observe that the images do not load properly.
3. Check the tracking system, which erroneously registers an "opened" event even before the email is opened.

Additional Information

• This issue is not limited to Gmail and may affect other email providers.