Skip to content

mlazdans/qnote

Repository files navigation

Table of contents

  1. About
  2. Features
  3. Usage
  4. Storage
  5. Popup windows
  6. Screenshots
  7. Building
  8. Releases
  9. Known issues
  10. Support
  11. Credits

About

This is the source code repository for the Thunderbird QNote extension.

Features

  • Add "sticky" notes to email messages
  • Save note position and size; multiple default note positions
  • Search notes using Thunderbird's built-in search (Edit / Find / Search Messages)
  • Filter and apply actions based on different conditions (Tools / Message Filters)
  • Clipboard copy/paste
  • Column with note icon and preview
  • Bulk operations on multiple message selections: create, update, delete, reset, copy, paste
  • Light and dark themes
  • Multiple locales and localized date formats
  • Tag messages when creating notes
  • Fully compatible with XNote++ (3.0.0)
  • Import / export between XNote++ (.xnote) and QNote (.qnote) file formats
  • Supports Thunderbird versions, starting from 68.2.0 (check archive for latest supported version for your Thunderbird installation)
  • Simple templating support

Usage

  • Press Alt+Q to toggle the note
  • Press ESC to close the note without saving
  • Right-click on message(s) to access more commands in the context menu
  • Use the built-in search to search within notes
  • Use the built-in Filter Manager to create custom filters and actions

Storage

There are two options for storing notes:

  • Storing inside the extension (deprecated)
  • Storing in a folder

Currently, there is no built-in mechanism for sharing notes across multiple computers. For now, in order to share notes across multiple computers, you could use shared folder solutions like Dropbox, NFS, or Windows/Samba shares.

If you are migrating from the XNote++ extension, you have two options: using the XNote++ folder directly or importing notes into the QNote folder. For more information, refer to the migration guide.

If you are using internal storage, don't forget to export data before removing the extension.

Popup windows

There are two options for note windows:

  • floating panel
  • popup window

Floating panel looks better but might not work well on all platforms. Fall back to popup window if you experience difficulties with the floating panel. The popup window uses Thunderbird's standard API.

Screenshots

Note popup Attach to message

Attach to print Column header

Message filters Message search

Building

npm install
./node_modules/.bin/tsc
build.bat

All assets should now be placed in the dist/release folder if there are no errors.

Use make_xpi.bat to generate a .xpi ZIP file or point to dist/release as the source folder for Tools / Developer Tools / Debug Add-ons.

If you are using Linux, adjust .bat files to the appropriate Linux commands.

Releases

Official releases are published on addons.thunderbird.net website.

Known issues

  • It does not work well together with the Conversations extension.

Support

Maintaining this extension requires a significant amount of time. If you find it useful, and you'd like to support its development, contributions in EUR or USD via PayPal would be greatly appreciated.

Credits