Thunderbird WebExtension API

https://webextension-api.thunderbird.net/en/latest
Admin
Thunderbird WebExtension API provides a comprehensive set of APIs for developing extensions that...
Tokens:801,818
Snippets:5,737
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### install(options)

Source: https://webextension-api.thunderbird.net/en/latest/management.html

Installs and enables a theme extension from a given URL.

```APIDOC
## install(options)

### Description
Installs and enables a theme extension from the given url.

### Note
The installable file pointed to by url must be a theme, and not a normal browser extension.

### Parameters
#### Request Body
- **options** (object) - Required
  - **url** (HttpURL) - Required - URL pointing to the XPI file on addons.mozilla.org or similar.
  - **hash** (string, optional) - A hash of the XPI file, using sha256 or stronger.

### Return Type
Promise<object>
  - **id** (ExtensionID)

### Required Permissions
- management
```

--------------------------------

### onStartup

Source: https://webextension-api.thunderbird.net/en/latest/runtime.html

Fired when a profile that has this extension installed first starts up. This event is not fired for incognito profiles.

```APIDOC
## onStartup

### Description
Fired when a profile that has this extension installed first starts up. This event is not fired for incognito profiles.

### Method
`runtime.onStartup.addListener(listener)`

### Parameters
#### Listener Parameters
- **listener** () - No parameters are passed to the listener function.
```

--------------------------------

### management.install

Source: https://webextension-api.thunderbird.net/en/latest/composeAction.html

Installs a new extension from a specified URL or file. Requires installation options.

```APIDOC
## management.install

### Description
Installs a new extension from a specified URL or file. Requires installation options.

### Method
Not specified (likely asynchronous API call)

### Parameters
* **options** (object) - Required - An object containing options for the installation, such as the source URL or path of the extension.
```

--------------------------------

### Install Extension

Source: https://webextension-api.thunderbird.net/en/latest/management.html

Installs a new extension. The URL must point to a valid extension.

```APIDOC
## POST /management/install

### Description
Installs a new extension. The URL must point to a valid extension.

### Method
POST

### Endpoint
/management/install

### Parameters
#### Request Body
- **options** (object) - Required - Options for installation.
  - **url** (HttpURL) - Required - The URL of the extension to install.
```

--------------------------------

### Get All Extensions

Source: https://webextension-api.thunderbird.net/en/latest/management.html

Retrieves information about all installed extensions.

```APIDOC
## GET /management/getAll

### Description
Retrieves information about all installed extensions.

### Method
GET

### Endpoint
/management/getAll
```

--------------------------------

### management.install

Source: https://webextension-api.thunderbird.net/en/latest/guides/manifestV3.html

Installs a new extension from a specified URL or file. Requires appropriate permissions to install extensions.

```APIDOC
## management.install

### Description
Installs a new extension from a specified URL or file.

### Method
management.install(options)

### Parameters
* **options** (object) - Required - An object containing installation options, such as the source URL of the extension.
```

--------------------------------

### onInstalled Event

Source: https://webextension-api.thunderbird.net/en/latest/runtime.html

Fired when the extension is first installed, updated, or the browser is updated. It accepts a listener function that receives installation details.

```APIDOC
## onInstalled

### Description
Fired when the extension is first installed, when the extension is updated to a new version, and when the browser is updated to a new version.

### Method
`addListener(listener)`

### Parameters
#### Listener Function Parameters
- **details** (object) - An object containing details about the installation.
  - **reason** (OnInstalledReason) - The reason that this event is being dispatched.
  - **temporary** (boolean) - Indicates whether the addon is installed as a temporary extension. [Added in TB 55]
  - **id** (string, optional) - Indicates the ID of the imported shared module extension which updated. This is present only if ‘reason’ is ‘shared_module_update’. **Unsupported.**
  - **previousVersion** (string, optional) - Indicates the previous version of the extension, which has just been updated. This is present only if ‘reason’ is ‘update’. [Added in TB 55]
```

--------------------------------

### Install a Library

Source: https://webextension-api.thunderbird.net/en/latest/guides/vendoring.html

Install a library like dompurify. This adds it to your package.json dependencies and records the exact version in package-lock.json.

```bash
npm install dompurify

```

--------------------------------

### management.install

Source: https://webextension-api.thunderbird.net/en/latest/dns.html

Installs a new extension from a provided URL. This function allows users or administrators to install extensions programmatically.

```APIDOC
## management.install

### Description
Installs a new extension from a provided URL.

### Method
management.install

### Parameters
#### Path Parameters
- **options** (object) - Required - Options for the installation.
  - **url** (HttpURL) - Required - The URL of the extension to install.
  - **filename** (string) - Optional - The filename of the extension package.

### Response
#### Success Response (ExtensionInfo)
Returns the ExtensionInfo object of the newly installed extension.
```

--------------------------------

### Install Latest Version of a Vendored Library

Source: https://webextension-api.thunderbird.net/en/latest/guides/vendoring.html

Use this command to install the latest version of a library managed by package.json. This command updates both the package.json and its corresponding lock file.

```bash
npm install dompurify@latest

```

--------------------------------

### management API

Source: https://webextension-api.thunderbird.net/en/latest/windows.html

Manages installed extensions, allowing extensions to get information about themselves and other extensions, install, enable, and disable them.

```APIDOC
## management API

### Description
Manages installed extensions, allowing extensions to get information about themselves and other extensions, install, enable, and disable them.

### Functions

*   **get(id)**: Retrieves information about a specific extension.
*   **getAll()**: Retrieves information about all installed extensions.
*   **getSelf()**: Retrieves information about the calling extension.
*   **install(options)**: Installs a new extension.
*   **setEnabled(id, enabled)**: Enables or disables an extension.
*   **uninstallSelf([options])**: Uninstalls the calling extension.

### Events

*   **onDisabled**: Fired when an extension is disabled.
*   **onEnabled**: Fired when an extension is enabled.
*   **onInstalled**: Fired when an extension is installed.
*   **onUninstalled**: Fired when an extension is uninstalled.

### Types

*   **ExtensionDisabledReason**: Reason why an extension was disabled.
*   **ExtensionID**: The unique identifier for an extension.
*   **ExtensionInfo**: Information about an extension.
*   **ExtensionInstallType**: The type of installation for an extension.
*   **ExtensionType**: The type of an extension.
*   **HttpURL**: Represents an HTTP URL.
*   **IconInfo**: Information about an extension icon.
```

--------------------------------

### Initialize package.json

Source: https://webextension-api.thunderbird.net/en/latest/guides/vendoring.html

Create a package.json file for your add-on project if one does not already exist.

```bash
npm init -y

```

--------------------------------

### management API

Source: https://webextension-api.thunderbird.net/en/latest/commands.html

Provides functions to manage installed extensions, including getting information, installing, enabling/disabling, and uninstalling extensions.

```APIDOC
## management API

### Description
Manages installed extensions within Thunderbird.

### Functions
*   `get(id)`: Retrieves information about a specific extension.
*   `getAll()`: Retrieves information about all installed extensions.
*   `getSelf()`: Retrieves information about the current extension.
*   `install(options)`: Installs a new extension.
*   `setEnabled(id, enabled)`: Enables or disables an extension.
*   `uninstallSelf([options])`: Uninstalls the current extension.

### Events
*   `onDisabled`: Fired when an extension is disabled.
*   `onEnabled`: Fired when an extension is enabled.
*   `onInstalled`: Fired when an extension is installed.
*   `onUninstalled`: Fired when an extension is uninstalled.

### Types
*   `ExtensionDisabledReason`
*   `ExtensionID`
*   `ExtensionInfo`
*   `ExtensionInstallType`
*   `ExtensionType`
*   `HttpURL`
*   `IconInfo`

### Properties
*   `ACTION_MENU_TOP_LEVEL_LIMIT`: The maximum number of top-level items allowed in the action menu.
```

--------------------------------

### beginNew

Source: https://webextension-api.thunderbird.net/en/latest/compose.html

Opens a new compose window.

```APIDOC
## beginNew([messageId], [details])

### Description
Opens a new compose window.

### Method
compose.beginNew

### Parameters
* **messageId** (string) - Optional - The ID of a message to pre-populate the new compose window with.
* **details** (ComposeDetails) - Optional - Initial details for the new compose window.
```

--------------------------------

### PKCS11 API Functions

Source: https://webextension-api.thunderbird.net/en/latest/alarms.html

Functions for managing PKCS11 modules, including getting module slots, installing, checking installation status, and uninstalling.

```APIDOC
## PKCS11 API Functions

### Description
Functions for managing PKCS11 cryptographic modules, including retrieving information about module slots, installing and uninstalling modules, and checking if a module is installed.

### Functions
- **getModuleSlots**(name)
- **installModule**(name, [flags])
- **isModuleInstalled**(name)
- **uninstallModule**(name)
```

--------------------------------

### pkcs11 API Functions

Source: https://webextension-api.thunderbird.net/en/latest/changelog/112.html

Functions for managing PKCS#11 modules, including getting module slots, installing, checking installation status, and uninstalling modules.

```APIDOC
## pkcs11 API Functions

### Description
Provides functions for managing PKCS#11 cryptographic modules.

### Functions
- **getModuleSlots(name)**: Retrieves the slots available for a given PKCS#11 module.
- **installModule(name, [flags])**: Installs a PKCS#11 module.
- **isModuleInstalled(name)**: Checks if a PKCS#11 module is installed.
- **uninstallModule(name)**: Uninstalls a PKCS#11 module.
```

--------------------------------

### onUpdateAvailable

Source: https://webextension-api.thunderbird.net/en/latest/runtime.html

Fired when an update is available, but isn’t installed immediately because the app is currently running. If you do nothing, the update will be installed the next time the background page gets unloaded, if you want it to be installed sooner you can explicitly call reload().

```APIDOC
## onUpdateAvailable

### Description
Fired when an update is available, but isn’t installed immediately because the app is currently running. If you do nothing, the update will be installed the next time the background page gets unloaded, if you want it to be installed sooner you can explicitly call reload(). If your extension is using a persistent background page, the background page of course never gets unloaded, so unless you call reload() manually in response to this event the update will not get installed until the next time the browser itself restarts. If no handlers are listening for this event, and your extension has a persistent background page, it behaves as if reload() is called in response to this event.

### Method
`runtime.onUpdateAvailable.addListener(listener)`

### Parameters
#### Listener Parameters
- **details** (object) - Required - The manifest details of the available update.
  - **version** (string) - Required - The version number of the available update.
```

--------------------------------

### compose.beginNew

Source: https://webextension-api.thunderbird.net/en/latest/management.html

Opens a new compose window.

```APIDOC
## POST /compose/beginNew

### Description
Opens a new compose window.

### Method
POST

### Endpoint
/compose/beginNew

### Parameters
#### Path Parameters
- **messageId** (string) - Optional - The ID of a message to use as a base for the new compose window.
- **details** (ComposeDetails) - Optional - Initial details for the new compose window.
```

--------------------------------

### management API

Source: https://webextension-api.thunderbird.net/en/latest/privacy.websites.protectedContentEnabled.html

Manages extensions, allowing users to get information about extensions, install, enable, and disable them. It also provides events for extension lifecycle changes.

```APIDOC
## management API

### Description
Manages extensions, allowing users to get information about extensions, install, enable, and disable them. It also provides events for extension lifecycle changes.

### Functions
*   **get(id)**: Gets information about a specific extension.
*   **getAll()**: Gets information about all installed extensions.
*   **getSelf()**: Gets information about the calling extension.
*   **install(options)**: Installs an extension.
*   **setEnabled(id, enabled)**: Enables or disables an extension.
*   **uninstallSelf([options])**: Uninstalls the calling extension.

### Events
*   **onDisabled**: Fired when an extension is disabled.
*   **onEnabled**: Fired when an extension is enabled.
*   **onInstalled**: Fired when an extension is installed.
*   **onUninstalled**: Fired when an extension is uninstalled.

### Types
*   **ExtensionDisabledReason**: Reason why an extension was disabled.
*   **ExtensionID**: The ID of an extension.
*   **ExtensionInfo**: Information about an extension.
*   **ExtensionInstallType**: The type of installation for an extension.
*   **ExtensionType**: The type of an extension.
*   **HttpURL**: Represents an HTTP URL.
*   **IconInfo**: Information about an extension icon.
```

--------------------------------

### Interact with MailFolder and Message Objects

Source: https://webextension-api.thunderbird.net/en/latest/guides/experiments.html

Use `folderManager` and `messageManager` to get native folder and message objects from wrapper types, and vice versa. Start a `MessageList` from an array or enumerator of `nsIMsgDBHdr`.

```javascript
let realFolder = context.extension.folderManager.get(accountId, path);
```

```javascript
context.extension.folderManager.convert(realFolder);
```

```javascript
let realMessage = context.extension.messageManager.get(messageId);
```

```javascript
context.extension.messageManager.convert(realMessage);
```

```javascript
context.extension.messageManager.startMessageList(realFolder.messages);
```

--------------------------------

### Run Build Script

Source: https://webextension-api.thunderbird.net/en/latest/guides/vendoring.html

Execute the npm build script to copy vendored files and package your add-on.

```bash
npm run build

```

--------------------------------

### commands API

Source: https://webextension-api.thunderbird.net/en/latest/proxy.html

The commands API allows extensions to declare commands that users can invoke, for example, by pressing a keyboard shortcut. It provides functions to get all commands and open the shortcut settings UI.

```APIDOC
## commands API

### Description
Allows extensions to define and manage keyboard shortcuts or other commands for user interaction.

### Functions

*   **getAll()**
    *   Retrieves all commands declared by the extension.

*   **openShortcutSettings()**
    *   Opens the Thunderbird shortcut settings UI where users can configure commands.
```

--------------------------------

### get

Source: https://webextension-api.thunderbird.net/en/latest/windows.html

Gets details about a specific window using its ID.

```APIDOC
## get

### Description
Retrieves details about a specific window identified by its ID.

### Method
`windows.get`

### Parameters
#### windowId
- **windowId** (integer) - Required - The ID of the window to retrieve details for.

#### getInfo
- **getInfo** (GetInfo, optional) - An object that can contain additional information or filters for the retrieval (details not specified in source).

### Return Type
Promise<Window> - Contains details about the specified window.
```

--------------------------------

### getAll()

Source: https://webextension-api.thunderbird.net/en/latest/management.html

Retrieves a list of information about all installed extensions.

```APIDOC
## getAll()

### Description
Returns a list of information about installed extensions.

### Note
Before version 56, only extensions whose ‘type’ is ‘theme’ are returned.

### Return Type
Promise<Array<ExtensionInfo>>

### Required Permissions
- management
```

--------------------------------

### windows.create

Source: https://webextension-api.thunderbird.net/en/latest/management.html

Creates a new browser window. Accepts an optional object with properties to configure the new window.

```APIDOC
## windows.create

### Description
Creates a new browser window. Accepts an optional object with properties to configure the new window.

### Method
windows.create

### Parameters
#### Path Parameters
- **createData** (object) - Optional - An object with properties to configure the new window.

### Request Example
```javascript
windows.create({ url: "https://www.example.com" });
```

### Response
#### Success Response (Window)
- **windowId** (integer) - The ID of the newly created window.
- **tabs** (array of objects) - An array of tab objects representing the tabs in the new window.

#### Response Example
```json
{
  "windowId": 1,
  "tabs": [
    {
      "id": 10,
      "index": 0,
      "windowId": 1,
      "openerTabId": null,
      "highlighted": true,
      "active": true,
      "url": "https://www.example.com",
      "pinned": false,
      "status": "complete",
      "incognito": false,
      "width": 800,
      "height": 600,
      "top": 50,
      "left": 50
    }
  ]
}
```
```

--------------------------------

### get

Source: https://webextension-api.thunderbird.net/en/latest/browserSettings.cacheEnabled.html

Gets the value of the cacheEnabled setting. Requires the 'browserSettings' permission.

```APIDOC
## get(details)

### Description
Gets the value of a setting.

### Parameters
#### details (object)
- **incognito** (boolean, optional) - Whether to return the value that applies to the incognito session (default false).

### Return type (Promise)
- **levelOfControl** (LevelOfControl) - The level of control of the setting.
- **value** (any) - The value of the setting.
- **incognitoSpecific** (boolean, optional) - Whether the effective value is specific to the incognito session. This property will _only_ be present if the incognito property in the details parameter of get() was true.

### Required permissions
- browserSettings
```

--------------------------------

### get

Source: https://webextension-api.thunderbird.net/en/latest/privacy.network.webRTCIPHandlingPolicy.html

Gets the current value of a WebRTC IP handling policy setting.

```APIDOC
## get

### Description
Gets the value of a setting.

### Parameters
#### details (object)
Which setting to consider.
- **incognito** (boolean, optional) - Whether to return the value that applies to the incognito session (default false).

### Return type (Promise)
- **levelOfControl** (LevelOfControl) - The level of control of the setting.
- **value** (any) - The value of the setting.
- **incognitoSpecific** (boolean, optional) - Whether the effective value is specific to the incognito session. This property will _only_ be present if the incognito property in the details parameter of get() was true.

### Required permissions
- privacy
```

--------------------------------

### commands.openShortcutSettings

Source: https://webextension-api.thunderbird.net/en/latest/changelog/109.html

Opens the shortcut settings page.

```APIDOC
## commands.openShortcutSettings

### Description
Opens the shortcut settings page.

### Method
commands.openShortcutSettings()

### Response
#### Success Response (200)
- (No specific response body defined, typically indicates success)

#### Response Example
(No example provided)
```

--------------------------------

### onInstalled Event

Source: https://webextension-api.thunderbird.net/en/latest/management.html

Fired when an add-on has been installed. Requires the 'management' permission.

```APIDOC
## Event: onInstalled

### Description
Fired when an addon has been installed.

### Note
Before version 56, only extensions whose type is ‘theme’ are supported.

### Listener Signature
`listener(info)`

### Parameters
#### info
- **info** (ExtensionInfo) - Required - Information about the installed extension.
```

--------------------------------

### get

Source: https://webextension-api.thunderbird.net/en/latest/browserSettings.openUrlbarResultsInNewTabs.html

Gets the current value of the openUrlbarResultsInNewTabs setting. Requires the 'browserSettings' permission.

```APIDOC
## get(details)

### Description
Gets the value of a setting.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **details** (object) - Required - Which setting to consider.
  - **incognito** (boolean, optional) - Whether to return the value that applies to the incognito session (default false).

### Request Example
```json
{
  "details": {
    "incognito": false
  }
}
```

### Response
#### Success Response (200)
- **levelOfControl** (LevelOfControl) - The level of control of the setting.
- **value** (any) - The value of the setting.
- **incognitoSpecific** (boolean, optional) - Whether the effective value is specific to the incognito session. This property will _only_ be present if the incognito property in the details parameter of get() was true.

### Response Example
```json
{
  "levelOfControl": "user",
  "value": true
}
```

### Permissions
- browserSettings
```

--------------------------------

### management.getAll

Source: https://webextension-api.thunderbird.net/en/latest/composeAction.html

Retrieves information about all installed extensions. Returns an array of ExtensionInfo objects.

```APIDOC
## management.getAll

### Description
Retrieves information about all installed extensions. Returns an array of ExtensionInfo objects.

### Method
Not specified (likely asynchronous API call)

### Parameters
None
```

--------------------------------

### get

Source: https://webextension-api.thunderbird.net/en/latest/browserSettings.openBookmarksInNewTabs.html

Gets the current value of the openBookmarksInNewTabs setting. Requires the 'browserSettings' permission.

```APIDOC
## get(details)

### Description
Gets the value of a setting.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **details** (object) - Required - Which setting to consider.
  - **incognito** (boolean, optional) - Whether to return the value that applies to the incognito session (default false).
  - **incognitoSpecific** (boolean, optional) - Whether the effective value is specific to the incognito session. This property will _only_ be present if the incognito property in the details parameter of get() was true.

### Request Example
```json
{
  "details": {
    "incognito": false
  }
}
```

### Response
#### Success Response (200)
- **levelOfControl** (LevelOfControl) - The level of control of the setting.
- **value** (any) - The value of the setting.
- **incognitoSpecific** (boolean, optional) - Whether the effective value is specific to the incognito session. This property will _only_ be present if the incognito property in the details parameter of get() was true.

#### Response Example
```json
{
  "levelOfControl": "user",
  "value": true
}
```

### Error Handling
No specific error handling is documented.
```

--------------------------------

### management API

Source: https://webextension-api.thunderbird.net/en/latest/changelog/147.html

Manages installed extensions, allowing retrieval, installation, and enabling/disabling.

```APIDOC
## management.get

### Description
Gets information about a specific extension.

### Method
management.get(id)

### Parameters
- **id** (ExtensionID) - The ID of the extension.

### Returns
- Promise<ExtensionInfo>
```

```APIDOC
## management.getAll

### Description
Gets information about all installed extensions.

### Method
management.getAll()

### Returns
- Promise<ExtensionInfo[]>
```

```APIDOC
## management.getSelf

### Description
Gets information about the calling extension.

### Method
management.getSelf()

### Returns
- Promise<ExtensionInfo>
```

```APIDOC
## management.install

### Description
Installs an extension from a given URL.

### Method
management.install(options)

### Parameters
- **options** (object) - Options for the installation, including the URL of the extension.

### Returns
- Promise<ExtensionInfo>
```

```APIDOC
## management.setEnabled

### Description
Enables or disables an extension.

### Method
management.setEnabled(id, enabled)

### Parameters
- **id** (ExtensionID) - The ID of the extension.
- **enabled** (boolean) - Whether to enable or disable the extension.
```

```APIDOC
## management.uninstallSelf

### Description
Uninstalls the calling extension.

### Method
management.uninstallSelf([options])

### Parameters
- **options** (object, optional) - Options for the uninstallation.
```

```APIDOC
## management.onDisabled

### Description
Fired when an extension is disabled.

### Events
- onDisabled
```

```APIDOC
## management.onEnabled

### Description
Fired when an extension is enabled.

### Events
- onEnabled
```

```APIDOC
## management.onInstalled

### Description
Fired when an extension is installed.

### Events
- onInstalled
```

```APIDOC
## management.onUninstalled

### Description
Fired when an extension is uninstalled.

### Events
- onUninstalled
```

--------------------------------

### installModule

Source: https://webextension-api.thunderbird.net/en/latest/pkcs11.html

Installs a PKCS#11 module with a given name. An optional flags parameter can be provided. Requires the 'pkcs11' permission.

```APIDOC
## installModule(name, [flags])

### Description
Install a PKCS#11 module with a given name.

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the module to install.
- **flags** (integer) - Optional - Flags to control the installation behavior.

### Required Permissions
- pkcs11
```

--------------------------------

### download(options)

Source: https://webextension-api.thunderbird.net/en/latest/downloads.html

Initiates the download of a specified URL. This function supports various options for controlling the download process, including headers, filename, and whether to prompt the user for saving.

```APIDOC
## download(options)

### Description
Download a URL. If the URL uses the HTTP[S] protocol, then the request will include all cookies currently set for its hostname. If both filename and saveAs are specified, then the Save As dialog will be displayed, pre-populated with the specified filename. If the download started successfully, callback will be called with the new DownloadItem’s downloadId. If there was an error starting the download, then callback will be called with downloadId=undefined and chrome.extension.lastError will contain a descriptive string. The error strings are not guaranteed to remain backwards compatible between releases. You must not parse it.

### Parameters
#### Path Parameters
- **options** (object) - Required - What to download and how.
  - **url** (string) - Required - The URL to download.
  - **allowHttpErrors** (boolean, optional) - When this flag is set to true, then the browser will allow downloads to proceed after encountering HTTP errors such as 404 Not Found.
  - **body** (string, optional) - Post body.
  - **conflictAction** (FilenameConflictAction, optional)
  - **cookieStoreId** (string, optional) - The cookie store ID of the contextual identity; requires “cookies” permission.
  - **filename** (string, optional) - A file path relative to the Downloads directory to contain the downloaded file.
  - **headers** (array of object, optional) - Extra HTTP headers to send with the request if the URL uses the HTTP[s] protocol. Each header is represented as a dictionary containing the keys name and either value or binaryValue, restricted to those allowed by XMLHttpRequest.
  - **incognito** (boolean, optional) - Whether to associate the download with a private browsing session.
  - **method** (string, optional) - The HTTP method to use if the URL uses the HTTP[S] protocol. Supported values: GET, POST.
  - **saveAs** (boolean, optional) - Use a file-chooser to allow the user to select a filename. If the option is not specified, the file chooser will be shown only if the Thunderbird “Always ask you where to save files” option is enabled (i.e. the pref browser.download.useDownloadDir is set to false).

### Return type (Promise)
_returns
  * integer

### Required Permissions
- downloads
```

--------------------------------

### management API

Source: https://webextension-api.thunderbird.net/en/latest/changelog/129.html

Provides functions to manage installed extensions, including installation, uninstallation, and enabling/disabling.

```APIDOC
## management.get

### Description
Retrieves information about a specific extension.

### Method
browser.management.get(id)

### Parameters
* **id** (string) - The ID of the extension to retrieve.

## management.getAll

### Description
Retrieves information about all installed extensions.

### Method
browser.management.getAll()

## management.getSelf

### Description
Retrieves information about the current extension.

### Method
browser.management.getSelf()

## management.install

### Description
Installs an extension from a given URL.

### Method
browser.management.install(options)

### Parameters
* **options** (object) - An object containing installation options, such as the URL of the extension.

## management.setEnabled

### Description
Enables or disables an extension.

### Method
browser.management.setEnabled(id, enabled)

### Parameters
* **id** (string) - The ID of the extension.
* **enabled** (boolean) - Whether to enable or disable the extension.

## management.uninstallSelf

### Description
Uninstalls the current extension.

### Method
browser.management.uninstallSelf([options])

### Parameters
* **options** (object) - Optional. Options for uninstallation.
```

--------------------------------

### commands.openShortcutSettings()

Source: https://webextension-api.thunderbird.net/en/latest/commands.html

Opens the Thunderbird shortcut settings UI, allowing users to view and modify extension-defined shortcuts.

```APIDOC
## commands.openShortcutSettings()

### Description
Opens the Thunderbird shortcut settings UI, allowing users to view and modify extension-defined shortcuts.

### Function Signature
```javascript
commands.openShortcutSettings()
```

### Returns
- **Promise<void>**: A promise that resolves when the settings UI has been opened.
```

--------------------------------

### management API

Source: https://webextension-api.thunderbird.net/en/latest/addressBooks.html

Manages installed extensions, allowing extensions to be enabled, disabled, installed, and uninstalled.

```APIDOC
## management.get

### Description
Gets information about a specific extension.

### Method
management.get

### Parameters
* **id** (string) - Required - The ID of the extension.

### Response
#### Success Response (ExtensionInfo)

```

```APIDOC
## management.getAll

### Description
Gets information about all installed extensions.

### Method
management.getAll

### Response
#### Success Response (array of ExtensionInfo)

```

```APIDOC
## management.getSelf

### Description
Gets information about the calling extension.

### Method
management.getSelf

### Response
#### Success Response (ExtensionInfo)

```

```APIDOC
## management.install

### Description
Installs an extension from a URL.

### Method
management.install

### Parameters
* **options** (object) - Required - Options for installation, including the URL.

### Response
#### Success Response (ExtensionInfo)

```

```APIDOC
## management.setEnabled

### Description
Enables or disables an extension.

### Method
management.setEnabled

### Parameters
* **id** (string) - Required - The ID of the extension.
* **enabled** (boolean) - Required - Whether to enable or disable the extension.

### Response
#### Success Response (void)

```

```APIDOC
## management.uninstallSelf

### Description
Uninstalls the calling extension.

### Method
management.uninstallSelf

### Parameters
* **options** (object) - Optional - Options for uninstallation.

### Response
#### Success Response (void)

```

--------------------------------

### launchWebAuthFlow(details)

Source: https://webextension-api.thunderbird.net/en/latest/identity.html

Starts an auth flow at the specified URL.

```APIDOC
## launchWebAuthFlow(details)

### Description
Starts an auth flow at the specified URL.

### Parameters
#### Required Parameters
- **details** (object)
  - **url** (HttpURL)
#### Optional Parameters
- **details.interactive** (boolean, optional)

### Returns
- **string** - The resulting URL from the auth flow.

### Permissions
- identity
```

--------------------------------

### getAll

Source: https://webextension-api.thunderbird.net/en/latest/windows.html

Gets all windows. [Added in TB 62]

```APIDOC
## getAll([getInfo])

### Description
Gets all windows.

### Parameters
#### Path Parameters
- **getInfo** (`GetInfo`, optional) - Optional parameter to get additional information about the windows.

### Return type
Promise<Array<Window>>
```

--------------------------------

### getAcceptLanguages()

Source: https://webextension-api.thunderbird.net/en/latest/i18n.html

Gets the accept-languages of the browser. This is different from the locale used by the browser; to get the locale, use getUILanguage().

```APIDOC
## getAcceptLanguages()

### Description
Gets the accept-languages of the browser.

### Return type (Promise)
* array of LanguageCode - Array of LanguageCode
```

--------------------------------

### ExtensionInfo Object

Source: https://webextension-api.thunderbird.net/en/latest/management.html

Provides detailed information about an installed extension, including its properties, status, and installation details.

```APIDOC
## ExtensionInfo

### Description
Information about an installed extension.

### Type
object

### Properties
- **description** (string) - The description of this extension.
- **enabled** (boolean) - Whether it is currently enabled or disabled.
- **id** (string) - The extension’s unique identifier.
- **installType** (ExtensionInstallType) - How the extension was installed.
- **mayDisable** (boolean) - Whether this extension can be disabled or uninstalled by the user.
- **name** (string) - The name of this extension.
- **optionsUrl** (string) - The url for the item’s options page, if it has one.
- **type** (ExtensionType, optional) - The type of this extension, ‘extension’ or ‘theme’. Added in TB 55.
- **version** (string) - The version of this extension.
- **disabledReason** (ExtensionDisabledReason, optional) - A reason the item is disabled.
- **homepageUrl** (string, optional) - The URL of the homepage of this extension.
- **hostPermissions** (array of string, optional) - Returns a list of host based permissions.
- **icons** (array of IconInfo, optional) - A list of icon information.
- **permissions** (array of string, optional) - Returns a list of API based permissions.
- **shortName** (string, optional) - A short version of the name of this extension.
- **updateUrl** (string, optional) - The update URL of this extension.
- **versionName** (string, optional) - The version name of this extension if the manifest specified one.
```

--------------------------------

### create

Source: https://webextension-api.thunderbird.net/en/latest/spaces.html

Creates a new space and adds its button to the spaces toolbar.

```APIDOC
## create(name, tabProperties, [buttonProperties])

### Description
Creates a new space and adds its button to the spaces toolbar.

### Parameters
* **name** (string) - The name to assign to this space. May only contain alphanumeric characters and underscores. Must be unique for this extension.
* **tabProperties** (string or SpaceTabProperties) - The properties for the new tab being opened, when the associated button in the spaces toolbar is clicked. Either a _string_ specifying the default URL, or a SpaceTabProperties object. The URL may point to a WebExtension page or a web page.
* **buttonProperties** ([SpaceButtonProperties], optional) - Properties of the button in the spaces toolbar for the new space.

### Return type
Promise<Space>
```

--------------------------------

### downloads.download

Source: https://webextension-api.thunderbird.net/en/latest/accounts.html

Initiates a download.

```APIDOC
## downloads.download

### Description
Initiates a download.

### Method
downloads.download(options)

### Parameters
#### Path Parameters
- **options** (object) - Required - An object containing options for the download.
```

--------------------------------

### management API

Source: https://webextension-api.thunderbird.net/en/latest/browserSettings.colorManagement.useNativeSRGB.html

Manages installed extensions, allowing retrieval of extension information, installation, enabling/disabling, and uninstallation.

```APIDOC
## management.get

### Description
Gets information about a specific extension.

### Method
management.get(id)

### Parameters
* **id** (string) - The ID of the extension.

## management.getAll

### Description
Gets information about all installed extensions.

### Method
management.getAll()

## management.getSelf

### Description
Gets information about the extension that is calling this API.

### Method
management.getSelf()

## management.install

### Description
Installs an extension from a given URL.

### Method
management.install(options)

### Parameters
* **options** (object) - An object containing installation options, such as the URL of the extension.

## management.setEnabled

### Description
Enables or disables an extension.

### Method
management.setEnabled(id, enabled)

### Parameters
* **id** (string) - The ID of the extension.
* **enabled** (boolean) - Whether to enable or disable the extension.

## management.uninstallSelf

### Description
Uninstalls the extension that is calling this API.

### Method
management.uninstallSelf([options])

### Parameters
* **options** (object) - Optional. Options for uninstallation.
```

--------------------------------

### getPreferredSystemLanguages()

Source: https://webextension-api.thunderbird.net/en/latest/i18n.html

Gets the preferred locales of the operating system. This is different from the locales set in the browser; to get those, use getAcceptLanguages().

```APIDOC
## getPreferredSystemLanguages()

### Description
Gets the preferred locales of the operating system.

### Return type (Promise)
* array of LanguageCode - Array of LanguageCode
```

--------------------------------

### runtime.openOptionsPage

Source: https://webextension-api.thunderbird.net/en/latest/action.html

Opens the extension's options page.

```APIDOC
## runtime.openOptionsPage()

### Description
Opens the extension's options page.
```

--------------------------------

### management API

Source: https://webextension-api.thunderbird.net/en/latest/permissions.html

Manages extensions installed in Thunderbird, allowing retrieval of extension information, installation, enabling/disabling, and uninstallation.

```APIDOC
## management API

### Description
Manages extensions installed in Thunderbird, allowing retrieval of extension information, installation, enabling/disabling, and uninstallation.

### Functions
*   **get(id)**: Retrieves information about a specific extension.
*   **getAll()**: Retrieves information about all installed extensions.
*   **getSelf()**: Retrieves information about the calling extension.
*   **install(options)**: Installs a new extension.
*   **setEnabled(id, enabled)**: Enables or disables an extension.
*   **uninstallSelf([options])**: Uninstalls the calling extension.

### Events
*   **onDisabled**: Fired when an extension is disabled.
*   **onEnabled**: Fired when an extension is enabled.
*   **onInstalled**: Fired when an extension is installed.
*   **onUninstalled**: Fired when an extension is uninstalled.

### Types
*   **ExtensionDisabledReason**: Reason why an extension was disabled.
*   **ExtensionID**: The unique identifier for an extension.
*   **ExtensionInfo**: Information about an extension.
*   **ExtensionInstallType**: The type of installation for an extension.
*   **ExtensionType**: The type of an extension.
*   **HttpURL**: Represents an HTTP URL.
*   **IconInfo**: Information about an extension's icon.

### Properties
*   **ACTION_MENU_TOP_LEVEL_LIMIT**: The maximum number of top-level items allowed in the action menu.
```

--------------------------------

### beginReply(messageId, [replyType], [details])

Source: https://webextension-api.thunderbird.net/en/latest/compose.html

Opens a new message compose window replying to a given message. Requires the 'compose' permission.

```APIDOC
## beginReply(messageId, [replyType], [details])

### Description
Opens a new message compose window replying to a given message.

### Parameters
#### Path Parameters
- **messageId** (MessageId) - Required - The message to reply to.
- **replyType** (string, optional) - Supported values: `replyToAll`, `replyToList`, `replyToSender`.
- **details** (ComposeDetails, optional) - Additional details for composing the message.

### Return type (Promise)
- **Tab** - The tab object for the new compose window.
```

--------------------------------

### Manifest Commands Configuration

Source: https://webextension-api.thunderbird.net/en/latest/commands.html

Defines custom commands and special built-in shortcuts within the extension's manifest file. Use 'suggested_key' for custom shortcuts and 'description' to explain the command's purpose.

```json
{
  "commands": {
    "toggle-feature": {
      "suggested_key": {
        "default": "Ctrl+Shift+Y",
        "linux": "Ctrl+Shift+U"
      },
      "description": "Send a 'toggle-feature' event"
    },
    "_execute_compose_action": {
      "suggested_key": {
        "default": "Alt+F5"
      },
      "description": "Open the compose action popup"
    }
  }
}
```

--------------------------------

### compose.beginNew

Source: https://webextension-api.thunderbird.net/en/latest/accounts.html

Initiates a new message composition.

```APIDOC
## compose.beginNew

### Description
Initiates a new message composition.

### Method
compose.beginNew([messageId], [details])

### Parameters
#### Path Parameters
- **messageId** (string) - Optional - The ID of a message to base the new message on.
- **details** (ComposeDetails) - Optional - Initial details for the new message.
```

--------------------------------

### get

Source: https://webextension-api.thunderbird.net/en/latest/privacy.websites.resistFingerprinting.html

Gets the value of the resistFingerprinting setting. This function requires the 'privacy' permission and can optionally retrieve incognito session values.

```APIDOC
## get(details)

### Description
Gets the value of a setting.

### Parameters
#### details (object)
* **incognito** (`boolean`, optional) - Whether to return the value that applies to the incognito session (default false).

### Return type (Promise)
* **object**
  * **levelOfControl** (`LevelOfControl`) - The level of control of the setting.
  * **value** (`any`) - The value of the setting.
  * **incognitoSpecific** (`boolean`, optional) - Whether the effective value is specific to the incognito session. This property will _only_ be present if the incognito property in the details parameter of get() was true.

### Required permissions
* privacy
```

--------------------------------

### pkcs11.installModule

Source: https://webextension-api.thunderbird.net/en/latest/action.html

Installs a PKCS#11 module.

```APIDOC
## pkcs11.installModule(name, [flags])

### Description
Installs a PKCS#11 module.

### Parameters
* **name** (string) - The name of the module to install.
* **flags** (integer, optional) - Flags to control the installation.
```

--------------------------------

### get()

Source: https://webextension-api.thunderbird.net/en/latest/browserSettings.newTabPageOverride.html

Gets the current value of the new tab page override setting. It can optionally retrieve the incognito session's value.

```APIDOC
## get(details)

### Description
Gets the value of a setting.

### Method
`messenger.browserSettings.newTabPageOverride.get`

### Parameters
#### details (object)
* **incognito** (boolean, optional) - Whether to return the value that applies to the incognito session (default false).

### Return type (Promise)
* **object** - Details of the currently effective value.
  * **levelOfControl** (LevelOfControl) - The level of control of the setting.
  * **value** (any) - The value of the setting.
  * **incognitoSpecific** (boolean, optional) - Whether the effective value is specific to the incognito session. This property will only be present if the incognito property in the details parameter of get() was true.

### Required permissions
* browserSettings

### Example
```javascript
let { value } = await messenger.browserSettings.newTabPageOverride.get({});
```
```

--------------------------------

### windows.getAll

Source: https://webextension-api.thunderbird.net/en/latest/windows.html

Retrieves details about all browser windows.

```APIDOC
## windows.getAll

### Description
Retrieves details about all browser windows.

### Method
`windows.getAll(getInfo)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **getInfo** (object) - Optional - An object specifying which properties of the windows to retrieve. See the `GetInfo` type for details.

### Request Example
```json
{
  "populate": true
}
```

### Response
#### Success Response (200)
- **Window** (array) - An array of window objects, each representing a browser window.

#### Response Example
```json
[
  {
    "id": 1,
    "tabs": [
      {
        "id": 10,
        "index": 0,
        "windowId": 1,
        "openerTabId": null,
        "highlighted": true,
        "active": true,
        "url": "https://example.com",
        "title": "Example Domain",
        "favIconUrl": null,
        "status": "complete",
        "pinned": false,
        "incognito": false,
        "width": null,
        "height": null,
        "sessionId": null
      }
    ],
    "type": "normal",
    "state": "normal",
    "focused": true,
    "top": 0,
    "left": 0,
    "width": 800,
    "height": 600,
    "incognito": false
  }
]
```
```

--------------------------------

### Declare Bundled Libraries in VENDOR.md

Source: https://webextension-api.thunderbird.net/en/latest/guides/vendoring.html

List each bundled library with its packaged file path and source URL. This format is lenient but requires a trusted host and exact file.

```markdown
vendor/purify.min.js:
 - Version: 3.4.11
 - URL: https://cdn.jsdelivr.net/npm/dompurify@3.4.11/dist/purify.min.js

vendor/lighterhtml.min.js:
 - Version: 4.2.0
 - URL: https://cdn.jsdelivr.net/npm/lighterhtml@4.2.0/min.js

```

--------------------------------

### Manually Copy Library File

Source: https://webextension-api.thunderbird.net/en/latest/guides/vendoring.html

Copy the required library file from the node_modules directory to your add-on's vendor directory.

```bash
cp node_modules/dompurify/dist/purify.min.js vendor/purify.min.js

```

--------------------------------

### getDisplayedMessages

Source: https://webextension-api.thunderbird.net/en/latest/scripting.messageDisplay.html

Gets an array of messages currently displayed in the user's mail client. This can be useful for getting the IDs of messages that the user is currently viewing.

```APIDOC
## getDisplayedMessages

### Description
Gets an array of messages currently displayed in the user's mail client.

### Method
`getDisplayedMessages([tabId])`

### Parameters
#### Query Parameters
- **tabId** (integer) - Optional - The ID of the tab for which to retrieve the displayed messages. If not specified, the current tab is assumed.
```

--------------------------------

### open

Source: https://webextension-api.thunderbird.net/en/latest/spaces.html

Opens or switches to the specified space.

```APIDOC
## open(spaceId, [windowId])

### Description
Opens or switches to the specified space. Throws an exception if the requested space does not exist or was not created by this extension.

### Parameters
* **spaceId** (integer) - The id of the space.
* **windowId** ([integer], optional) - The id of the normal window, where the space should be opened. Defaults to the most recent normal window.

### Return type
Promise<Tab>
```
Tokens:
Raw