Quicktext v6 (Milesteone 2): Modified script support

[jobisoft]

Quicktext v6 has reached its second milestone in being converted to the WebExtension technology. The ultimate goals of this effort are described in the announcement for the first milestone. Everything mentioned there is still important, so if you have not read that, please do so soon.

One major change in v6 is the new script engine. Quicktext v5 executed scripts with system privileges and just like Quicktext itself, scripts had full access to the user's computer and could do everything. This is no longer the case for Quicktext v6.

TL;DR - What changed?

The following properties have been moved:

• this.mVariables -> this.quicktext.variables
• this.mQuicktext.get_<tag>([...]) -> await this.quicktext.getTag("<tag>", ...)

Example:

let rcpt = await this.quicktext.getTag('to', 'lastname');`

The following property has been removed:

• this.mWindow

Quicktext scripts now run with reduced privileges and can no longer use core functions of the compose window, or access its DOM elements. Most things formaly done via this.mWindow.* can still be achieved via this.compose.* (internal scripts) or via messenger.compose.* (external scripts).

Internal scripts

These scripts are how we used to define scripts in the "Scripts" tab of the Quicktext Manager UI. Internal scripts run with minimal privileges, but Quicktext exposes a subset of the official WebExtension APIs:

• this.compose.* -> compose API
• this.messages.* -> messages API
• this.identities.* -> identities API

The methods of this.compose.* differ from the methods of the official compose API: The first tabId parameter must not be specified, as the methods available to internal scripts will always act on the current compose window.

Note: The WebExtension APIs are used by add-on developers, are well documented and aim to be stable. That means scripts will not break anymore when a new version of Thunderbird is released.

To see everything that is available to internal scripts, use the following script and check the result printed to the error comsole:

console.log(this)

Currently, this will return something like the following:

Example

The AddRecipients community script now has to look like this:

  let type = this.quicktext.variables[0];
  let adresses = this.quicktext.variables[1].split(';');

  if (!type || !["to", "cc", "bcc", "reply-to"].includes(type)) {
    return;
  }

  if (type == "reply-to") {
    type = "replyTo";
  }

  let details = await this.compose.getComposeDetails();
  let recipients = new Set([...details[type], ...adresses].map(e => e.trim()));
  await this.compose.setComposeDetails({
    [type]: Array.from(recipients)
  });

Scripts no longer manipulate the compose fields directly, but can use getComposeDetails() to pull information from the composer and setComposeDetails() to update properties of the composer.

External scripts

There will be cases, where the API methods available to internal scripts will be insufficient. Furthermore, there might even be cases where scripts still need to do everything. Both scenarios can be solved by external scripts.

An external script is shipped in a separate add-on. Since it can be executed natively, it can use all WebExtension APIs. For advanced use-cases, such an external script add-on can even include an Experiment and have full access to the user's system again.

We created the Quicktext Community Scripts Add-on which provides most of the former community scripts. This does not only serve as a blueprint for custom script add-ons, but is intended to provide script support for the most common use-cases. Instead of manually maintaining scripts, users can install the Community Script Add-on.

If the Quicktext Community Script Add-on is installed, any of its stored scripts can be used in Quicktext via the CSCRIPT tag. Its first parameter is the name of the requested script, followed by variables passed into the script. The tag to execute its AddRecipients script has to look as follows:

[[CSCRIPT=AddRecipients|to|user@inter.net]]

In order to execute scripts of a custom script add-on, Quicktext needs to know the add-on's id. This is accomplished through the ESCRIPT tag. Since the id of the Community Script Add-on is quicktext.scripts@community.jobisoft.de, its AddRecipients script can also be executed via:

[[ESCRIPT=quicktext.scripts@community.jobisoft.de|AddRecipients|to|user@inter.net]]

The first parameter is the id of the script add-on, the second parameter is the name of the requested script, followed by variables passed into the script.

Need more help?

The converted community scripts shipped with the Quicktext Community Scripts Add-on should give you an idea how to convert your scripts.

[weksupport]

Stupid question, but :
_To see what is available for you, execute the following script:

console.log(this)_

How can I execute this script ?

I have the impression that I have to make the transition slowly, otherwise things will go wrong at all.

[jobisoft]

Stupid question, but : _To see what is available for you, execute the following script:

console.log(this)_

How can I execute this script ?

I have the impression that I have to make the transition slowly, otherwise things will go wrong at all.

Not a stupid question. You create a new script called for example test with only console.log(this) in it, and then you include that script in a new or existing template via the script tag. The script is then executed, when you include the template in a message.

[j-schneid]

I believe the question of the OP was: Where can I type the command? There must be a window, a prompt, some place to do so. I wouldn't know, either.
Although I'm not quite a novice user I hope all of this and the previous post isn't relevant for me, I believe I couldn't do all this conversion stuff. In my Quicktext settings window, I have only templates on the second tab. On the first tab I think there is nothing relevant (just top left two boxes checked) and on the third tab I don't have scripts. My text templates will be retained without any need for me to do anything - right?

[jobisoft]

My text templates will be retained without any need for me to do anything - right?

Correct. This is only relevant if you have scripts.

Here is a screenshot of the command saved as a script:

[jobisoft]

I would be interested in feedback from those, who were able to convert their scripts, or who are struggling. I currently have no information at all.

Thanks!

[weksupport]

When I 'run' ConsoleLog2 :

I don't know what is wrong.

We are now in a beta situation. Is it perhaps an idea to describe a procedure for the 'normal' user later on how to switch. I read about exporting first otherwise you will lose everything. Or will a silent transition be possible later on?

[jobisoft]

Uh, that is unexpected. It should work like that. What version of TB, what version of Quicktext?

[jobisoft]

Ah, you tried to execute console.log(this) in Quicktext v5. That does not work. This entire issue is about Quicktext v6, and how to convert the scripts from v5 to v6. None of what is written here applies to v5.

FYI: To see the console entries, open it via the Hamburger Menu -> Tools -> Developer Tools or Press CTRL+SHIFT+J in Thunderbirds main window

[jobisoft]

We are now in a beta situation. Is it perhaps an idea to describe a procedure for the 'normal' user later on how to switch. I read about exporting first otherwise you will lose everything. Or will a silent transition be possible later on?

The storage system changes. Quicktext v5 stored its config files directly on your hard disc, while Quicktext v6 stores them in a dedicates add-on storage. I do not delete the data from your local disc. So if you switch from v5 to v6 and decide to go back to v5, everything will be exactly as before you switched from v5 to v6.

Quicktext v6 will read the old v5 config data and convert it as needed and store it in the dedicated add-on storage. If you uninstall Quicktext v6, the data in the dedicated add-on storage will be deleted as well. So once you are beyond "trying it out", and actually converted your scripts to work with v6, you should export them before uninstalling v6.

Everyone using scripts should convert their scripts now. If I push v6 to everyone, old scripts will stop working, and you will be left with a broken workflow. There will be at least one more "milestone" message for milestone 3. I think I might suppress further notifications for users who do not have scripts, to not confuse them.

[weksupport]

Oke.. I dragged 6.3.* to Thunderbird 128.9.2esr and installed the newest version.
When I do some commands, the
comes in my email, where it was HTML - a new line.
Of is the newest version not for 128.9.2esr ?

[jobisoft]

Oke.. I dragged 6.3.* to Thunderbird 128.9.2esr and installed the newest version. When I do some commands, the comes in my email, where it was HTML - a new line. Of is the newest version not for 128.9.2esr ?

Can you append a screenshot so I can see what you mean? If you primary language is German, you could also write in German.

[weksupport]

I am Dutch and not good at languages, I try my best, but German is not a good alternative.

What I mean, when typing a shortcut, I always got:

Greetings,

Werner

and now I get

so then quickly back to 5.20 and it worked fine again.
However, after a restart of TB the shortcuts no longer work.
Yes through the menus but not through the shortcuts.

(Google Vertaal)