≡ On this page
These documents assume you already have some familiarity with the WebExtension technology. If not, it is highly recommended to start with the following pages:
For any problems or feature requests please file a bug.
Hint
In Thunderbird, all WebExtension API can be accessed through the browser.* namespace, as with Firefox, but also through the messenger.* namespace, which is a better fit for Thunderbird.
Important
WebExtension APIs are asynchronous, that is, they return a Promise object which resolves when ready. See Using Promises for more information about Promises.
The documentation for the APIs listed in the left side panel is generated automatically from Thunderbird's schema files. The webext-schemas repository can be used to obtain a copy of the relevant files.
.. toctree:: :hidden: :caption: API reference accounts addressBooks addressBooks.provider contacts mailingLists alarms browserAction browserSettings browserSettings.colorManagement browsingData clipboard cloudFile commands compose composeAction contentScripts contextualIdentities cookies declarativeNetRequest dns downloads extension composeScripts messageDisplayScripts folders i18n identities identity idle mailTabs management menus messageDisplay messageDisplayAction messages messages.tags notifications permissions pkcs11 privacy privacy.network privacy.services privacy.websites runtime scripting scripting.compose scripting.messageDisplay sessions spaces spacesToolbar storage tabs theme userScripts messengerUtilities webNavigation webRequest windows
.. toctree:: :glob: :maxdepth: 1 :caption: Examples examples/*
.. toctree:: :maxdepth: 1 :caption: Experiment APIs experiments/introduction experiments/generator experiments/folders_and_messages experiments/tabs_and_windows experiments/contribute
.. toctree:: :maxdepth: 1 :caption: Changelog changes/140 changes/128 changes/115 changes/102 changes/91 changes/78
- Introduction to add-on development
- Find information about creating and updating extensions for Thunderbird. Includes getting-started-tutorials and a collection of helpful articles and guides.
- Add-on developer community
- Learn how to get in touch with other Thunderbird add-on developers, to ask questions and to share knowledge.
- Sample extensions
- A collection of MailExtensions, showing how to use Thunderbird WebExtension APIs.
- MDN sample extensions
- A collection of WebExtensions, showing how to use WebExtension APIs in Firefox. They probably won't work directly in Thunderbird, but they may provide hints on how to use some of the WebExtension APIs that Thunderbird inherited from Firefox.
- MDN WebExtension documentation
- Find general information about the WebExtensions API cross-browser technology used by Firefox and many Chromium-based browsers. Not all information listed there apply to Thunderbird.