oss / shrunk-outlook-addin

Microsoft Outlook add-in for inserting shrunk tracking pixels to emails.

Shrunk Outlook Add-in

shrunk-outlook-demo.mp4

Goal

To easily insert images (specifically tracking pixels) to an Outlook Email.

Features

• Insert tracking pixels to your Outlook Email
• Support for (an infinite?) number of tracking pixels
• Automatically detect invisible tracking pixels as you draft your email
  • Undos, redos, re-ordering, deletions, etc. are all reflected onto the task pane
• Quickly show the locations of your tracking pixels within your email body
• Prevents multiple inserts of the same tracking pixel (even when you click thrice super fast!)

To Get Started

Prerequisites

1. Node.js
2. NPM

Steps

1. Clone the repo git clone [email protected]:oss/Shrunk-Outlook-Add-In.git and cd into the project.
2. Run npm install. Once installation is finished, run npm start.
3. Navigate to https://outlook.office.com/mail/
4. Open any email
5. Under the subject, there will be a few icons. Click the square with four circles inside of it (Apps)
6. Find the extension and click on it.
7. Follow the instructions.

Click here for more information on side loading.

Important Information

Side-loading only works for Windows machines.

shrunk-dist-prod.zip and shrunk-dist-dev.zip are distribution builds of this project that are built on every new tag creation (new release version. see .github/workflows/ci.yml for more details). They differ in their manifest.xml files: when grabbing assets, the base URL either becomes go.rutgers.edu/outlook/assets or shrunk.rutgers.edu/outlook/assets, where shrunk.r.e is the test instance of go.rutgers.edu.

shrunk-outlook-addin's Issues

GitHub Versioning Function is still running. Address it !!!

It's running the script. Make it run the one that works

Todo

• Add instructions on how to create a tracking pixel.
  from Aaron: "We'll probably want to put a bit of an instruction write-up together into the text area, stuff like that."

• Obtain Rutgers icon logos (consult to Brian)

• Multiple inserts (of invisible pixels) would lead to redundant tracking counts. Need a way to mitigate that.

• Figure out publishing

• Adding Prettier

• Thinking about user experience.... (remove button, user click multiple times, shrunk link detection to remind user which link they used, etc.)

• Added automatic updates between tracking pixel list and updates to the body by checking for differences in previous state (undos work, re-ordering works, redos work, etc.). This is to let the user know if they accidentally deleted the tracking pixel.

• Added ability to click on box to temporarily highlight the invisible tracking pixel.

• Alias extraction for go.rutgers.edu and shrunk links

• Added Feedback form link

  • Added fancy underline hover over animation

• Make it look pretty