Skip to content

Add Thunderbird Companion plugin - #354

Draft
mdj2812 wants to merge 5 commits into
noctalia-dev:mainfrom
mdj2812:dev/thunderbird-companion
Draft

Add Thunderbird Companion plugin#354
mdj2812 wants to merge 5 commits into
noctalia-dev:mainfrom
mdj2812:dev/thunderbird-companion

Conversation

@mdj2812

@mdj2812 mdj2812 commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Plugin

  • Id: mdj2812/thunderbird-companion
  • New plugin
  • Update to an existing plugin (version bumped in plugin.toml)

What it does

Adds a Thunderbird bar widget, recent-unread panel, and background service without duplicating IMAP/SMTP credentials. A bundled, readable MailExtension and native host expose unread metadata plus open, reply, compose, mark-read, mark-all-read, and archive actions through local native messaging.

Setup builds the XPI locally, installs the native host under XDG data paths, and leaves Thunderbird's permission approval as an explicit manual step. Cached messages remain visible while the native-host heartbeat distinguishes live and offline state.

External dependencies

  • thunderbird 128 or newer: mailbox, compose UI, and MailExtension APIs.
  • python3: bundled native-messaging host and deterministic local XPI build.
  • xdg-open: manually opens the generated XPI directory from the setup panel.

Testing

  • Tested on Niri
  • Tested on Hyprland
  • Tested on Sway
  • Tested on another compositor:
  • Noctalia version tested against: noctalia v5.0.0 (v5.0.0-beta.8-50-g713e6caa3ac6)
  • Plugin API level: 9

Screenshots / Videos

屏幕截图_20260814_001955 屏幕截图_20260814_001053

Checklist

  • The directory name matches the part of id after the / in plugin.toml exactly.
  • It ships plugin.toml, README.md, thumbnail.webp, and translations/en.json.
  • README.md follows the
    README template, documents
    every entry id and dependency, and includes exact panel IPC commands and launcher prefixes where applicable.
  • I created thumbnail.webp with the thumbnail generator.
  • version follows semver and is bumped in this PR; plugin_api is the oldest API level this plugin requires.
  • Every non-English translation in this PR uses a locale supported by Noctalia core, and I can read, write, and
    understand that language well enough to review and maintain it (no unreviewed machine/LLM translations).
  • I did not edit catalog.toml; CI generates it.
  • This PR touches exactly one plugin directory.

Code review attestation

Plugins run as trusted, unsandboxed Luau in the user's session. Confirm:

  • The code is readable and not obfuscated, minified, or generated.
  • It does not download and execute remote code.
  • Every network call, filesystem write, and spawned process is something the description above accounts for.
  • I have the right to publish this code under the license declared in plugin.toml.

Made with Cursor

mdj2812 and others added 5 commits August 14, 2026 00:05
Expose unread mail and common message actions through a pinned, verified local bridge without duplicating Thunderbird account credentials.

Co-authored-by: Cursor <cursoragent@cursor.com>
Ignore an orphaned native-messaging registration when the host and release marker are absent so fully removed add-ons return to first-time setup.

Co-authored-by: Cursor <cursoragent@cursor.com>
Keep the executable bridge source inside the reviewed plugin and build the XPI locally so setup works offline without downloading remote code.

Co-authored-by: Cursor <cursoragent@cursor.com>
Keep only readable bridge source in the plugin and ignore local Python cache artifacts during future validation.

Co-authored-by: Cursor <cursoragent@cursor.com>
@mdj2812
mdj2812 marked this pull request as ready for review August 15, 2026 10:15
@mdj2812

mdj2812 commented Aug 15, 2026

Copy link
Copy Markdown
Contributor Author

I am setting it ready for review, even though I am not quite sure if the current design is acceptable. Basically, it requires to firstly install a bridge plugin to the Thunderbird. The Thunderbird plugin is also brought by this Noctalia plugin too, some manual action is inevitably required from the user. @ItsLemmy waiting for your comments, thanks!

@ItsLemmy

Copy link
Copy Markdown
Contributor
  1. blocking - thunderbird-companion/thumbnail.webp:1

The rendered catalog thumbnail prominently identifies the plugin as "Media Controls" and "Audio • Widget", although
the screenshot and submitted plugin are Thunderbird Companion. This misidentifies the plugin in a required
user-visible asset. Regenerate the thumbnail with the correct plugin name and category.

  1. blocking - thunderbird-companion/plugin.toml:10

thunderbird-companion/service.luau:461-462 invokes bash to run the installer, but bash is absent from both the
manifest dependencies and thunderbird-companion/README.md:14-20. Repository policy requires every command the plugin
shells out to be declared and documented. On systems without Bash, the setup action cannot install the bridge.
Declare and document bash, or use an installer mechanism guaranteed by the runtime.

@ItsLemmy
ItsLemmy marked this pull request as draft August 16, 2026 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants