Skip to content
Frederick Zhang edited this page Jul 15, 2022 · 50 revisions

v0.3.0 wiki WIP

View wiki for v0.2.0 here

Installation and Configuration

Both the extension and the native messaging host need to be installed for it to work.

You can install the extension from addons.thunderbird.net and the messaging host from Releases; or both of them from Releases (the extension won't auto-update in this case). You'll need to download the messaging host again manually when the extension updates.

Read platform-specific pages below for details.

Tips, FAQ, and Troubleshooting

Editing emails

External Editor Revived presents emails in a format similar to EML:

Header1: foo
Header2: bar

Body

NB The blank line above body is mandatory. And there must be no blank lines in-between headers.

You can add or remove headers yourself. External Editor Revived recognises the following headers:

  • From
  • To
  • Cc
  • Bcc
  • Reply-To
  • X-ExtEditorR-Send-On-Save

Toolbar Buttons

  • Main window: click to create a new email, shift-click to enable send-on-exit by default
  • Composing window: click to edit current email, shift-click to enable send-on-exit by default

Keyboard Shortcuts

You can view and customise shortcuts at Add-ons Manager -> Extensions -> gear button -> Manage Extension Shortcuts.

List of supported commands:

  • Create a new message
  • Create a new message with Send-On-Exit
  • Edit current message (Ctrl-E on Linux/Windows, Command-E on macOS)*
  • Edit current message with Send-On-Exit (Ctrl-Shift-E on Linux/Windows, Command-Shift-E on macOS)*
  • Reply to sender
  • Reply to sender with Send-On-Exit
  • Reply to all
  • Reply to all with Send-On-Exit
  • Reply to list
  • Reply to list with Send-On-Exit

* If you have trouble resetting them to default under macOS, re-install the extension.

Send on Exit

If you use X-ExtEditorR-Send-On-Exit: true header in your email, External Editor Revived will try sending it out immediately after the editor process exits.

(Previously called 'Send on Save'.)

Plain text emails

For the best experience, configure Thunderbird to compose emails in plain text.

Navigate to Account Settings -> Composition & Addressing, then uncheck Compose messages in HTML format. You need to do this for all accounts that you'd like to use External Editor Revived with.

For more details, see: http://kb.mozillazine.org/Plain_text_e-mail_%28Thunderbird%29.

Advanced usage

Feel free to post your custom setup to Discussions as well!

FAQs

How does External Editor Revived work?

Since Thunderbird no longer supports XUL extensions, it's not possible to launch external program directly with an extension alone.

External Editor Revived uses a companion native messaging host which launches editors externally instead. Thunderbird starts the messaging host, sends all the info over to the messaging host via stdio, and waits for responses to update emails accordingly.

Why does External Editor Revived require these permissions?

  • Exchange messages with programs other than Thunderbird (nativeMessaging): To talk to the messaging host, which launches external editors
  • Read and modify your messages as you compose and send them (compose): To edit current email in composing window
  • Send composed email messages on your behalf (compose.send): To support Send-On-Exit
  • Read your email messages and mark or tag them (messagesRead): To reply to emails which needs messages IDs
  • Display notifications to you (notifications): To notify users of warnings and errors
  • storage: To store configurations

Troubleshooting

Where can I find logs?

Tools -> Developer Tools -> Error Console. Note you need to open Error Console first to see all logs.

You can also start Thunderbird with thunderbird --jsconsole, and it'll open Error Console immediately upon start.

I updated the MailExtension and the messaging host and it's now complaining 'version mismatch'

You need to reload the extension for it to pick up the latest messaging host binary.

Alternatively just restart Thunderbird.

Screenshots

main window composing window neovim options shortcuts

Clone this wiki locally